import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { CreateWorkspacesRequest, CreateWorkspacesResult } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; /** * @public * * The input for {@link CreateWorkspacesCommand}. */ export interface CreateWorkspacesCommandInput extends CreateWorkspacesRequest { } /** * @public * * The output of {@link CreateWorkspacesCommand}. */ export interface CreateWorkspacesCommandOutput extends CreateWorkspacesResult, __MetadataBearer { } declare const CreateWorkspacesCommand_base: { new (input: CreateWorkspacesCommandInput): import("@smithy/core/client").CommandImpl; new (input: CreateWorkspacesCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions; }; /** *

Creates one or more WorkSpaces.

*

This operation is asynchronous and returns before the WorkSpaces are created.

* *
    *
  • *

    The MANUAL running mode value is only supported by Amazon WorkSpaces * Core. Contact your account team to be allow-listed to use this value. For more * information, see Amazon WorkSpaces * Core.

    *
  • *
  • *

    You don't need to specify the PCOIP protocol for Linux bundles * because DCV (formerly WSP) is the default protocol for those bundles.

    *
  • *
  • *

    User-decoupled WorkSpaces are only supported by Amazon WorkSpaces * Core.

    *
  • *
  • *

    Review your running mode to ensure you are using one that is optimal for your needs and budget. * For more information on switching running modes, see * * Can I switch between hourly and monthly billing? *

    *
  • *
*
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { WorkSpacesClient, CreateWorkspacesCommand } from "@aws-sdk/client-workspaces"; // ES Modules import * // const { WorkSpacesClient, CreateWorkspacesCommand } = 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 = { // CreateWorkspacesRequest * Workspaces: [ // WorkspaceRequestList // required * { // WorkspaceRequest * DirectoryId: "STRING_VALUE", // required * UserName: "STRING_VALUE", // required * BundleId: "STRING_VALUE", // required * VolumeEncryptionKey: "STRING_VALUE", * UserVolumeEncryptionEnabled: true || false, * RootVolumeEncryptionEnabled: true || false, * 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", * }, * }, * Tags: [ // TagList * { // Tag * Key: "STRING_VALUE", // required * Value: "STRING_VALUE", * }, * ], * WorkspaceName: "STRING_VALUE", * Ipv6Address: "STRING_VALUE", * }, * ], * }; * const command = new CreateWorkspacesCommand(input); * const response = await client.send(command); * // { // CreateWorkspacesResult * // FailedRequests: [ // FailedCreateWorkspaceRequests * // { // FailedCreateWorkspaceRequest * // WorkspaceRequest: { // WorkspaceRequest * // DirectoryId: "STRING_VALUE", // required * // UserName: "STRING_VALUE", // required * // BundleId: "STRING_VALUE", // required * // VolumeEncryptionKey: "STRING_VALUE", * // UserVolumeEncryptionEnabled: true || false, * // RootVolumeEncryptionEnabled: true || false, * // 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", * // }, * // }, * // Tags: [ // TagList * // { // Tag * // Key: "STRING_VALUE", // required * // Value: "STRING_VALUE", * // }, * // ], * // WorkspaceName: "STRING_VALUE", * // Ipv6Address: "STRING_VALUE", * // }, * // ErrorCode: "STRING_VALUE", * // ErrorMessage: "STRING_VALUE", * // }, * // ], * // PendingRequests: [ // 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: { * // 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: [ * // "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: { * // 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"), * // }, * // ], * // }, * // ], * // }; * * ``` * * @param CreateWorkspacesCommandInput - {@link CreateWorkspacesCommandInput} * @returns {@link CreateWorkspacesCommandOutput} * @see {@link CreateWorkspacesCommandInput} for command's `input` shape. * @see {@link CreateWorkspacesCommandOutput} 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 ResourceLimitExceededException} (client fault) *

Your resource limits have been exceeded.

* * @throws {@link WorkSpacesServiceException} *

Base exception class for all service exceptions from WorkSpaces service.

* * * @public */ export declare class CreateWorkspacesCommand extends CreateWorkspacesCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: CreateWorkspacesRequest; output: CreateWorkspacesResult; }; sdk: { input: CreateWorkspacesCommandInput; output: CreateWorkspacesCommandOutput; }; }; }