Create Workspaces

workspaces_create_workspaces

R Documentation

Creates one or more WorkSpaces

Description

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 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?

Usage

workspaces_create_workspaces(Workspaces)

Arguments

Workspaces

[required] The WorkSpaces to create. You can specify up to 25 WorkSpaces.

Value

A list with the following syntax:

list(
  FailedRequests = list(
    list(
      WorkspaceRequest = list(
        DirectoryId = "string",
        UserName = "string",
        BundleId = "string",
        VolumeEncryptionKey = "string",
        UserVolumeEncryptionEnabled = TRUE|FALSE,
        RootVolumeEncryptionEnabled = TRUE|FALSE,
        WorkspaceProperties = list(
          RunningMode = "AUTO_STOP"|"ALWAYS_ON"|"MANUAL",
          RunningModeAutoStopTimeoutInMinutes = 123,
          RootVolumeSizeGib = 123,
          UserVolumeSizeGib = 123,
          ComputeTypeName = "VALUE"|"STANDARD"|"PERFORMANCE"|"POWER"|"GRAPHICS"|"POWERPRO"|"GRAPHICSPRO"|"GRAPHICS_G4DN"|"GRAPHICSPRO_G4DN",
          Protocols = list(
            "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"|"RHEL_8"
        ),
        Tags = list(
          list(
            Key = "string",
            Value = "string"
          )
        ),
        WorkspaceName = "string"
      ),
      ErrorCode = "string",
      ErrorMessage = "string"
    )
  ),
  PendingRequests = list(
    list(
      WorkspaceId = "string",
      DirectoryId = "string",
      UserName = "string",
      IpAddress = "string",
      State = "PENDING"|"AVAILABLE"|"IMPAIRED"|"UNHEALTHY"|"REBOOTING"|"STARTING"|"REBUILDING"|"RESTORING"|"MAINTENANCE"|"ADMIN_MAINTENANCE"|"TERMINATING"|"TERMINATED"|"SUSPENDED"|"UPDATING"|"STOPPING"|"STOPPED"|"ERROR",
      BundleId = "string",
      SubnetId = "string",
      ErrorMessage = "string",
      ErrorCode = "string",
      ComputerName = "string",
      VolumeEncryptionKey = "string",
      UserVolumeEncryptionEnabled = TRUE|FALSE,
      RootVolumeEncryptionEnabled = TRUE|FALSE,
      WorkspaceName = "string",
      WorkspaceProperties = list(
        RunningMode = "AUTO_STOP"|"ALWAYS_ON"|"MANUAL",
        RunningModeAutoStopTimeoutInMinutes = 123,
        RootVolumeSizeGib = 123,
        UserVolumeSizeGib = 123,
        ComputeTypeName = "VALUE"|"STANDARD"|"PERFORMANCE"|"POWER"|"GRAPHICS"|"POWERPRO"|"GRAPHICSPRO"|"GRAPHICS_G4DN"|"GRAPHICSPRO_G4DN",
        Protocols = list(
          "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"|"RHEL_8"
      ),
      ModificationStates = list(
        list(
          Resource = "ROOT_VOLUME"|"USER_VOLUME"|"COMPUTE_TYPE",
          State = "UPDATE_INITIATED"|"UPDATE_IN_PROGRESS"
        )
      ),
      RelatedWorkspaces = list(
        list(
          WorkspaceId = "string",
          Region = "string",
          State = "PENDING"|"AVAILABLE"|"IMPAIRED"|"UNHEALTHY"|"REBOOTING"|"STARTING"|"REBUILDING"|"RESTORING"|"MAINTENANCE"|"ADMIN_MAINTENANCE"|"TERMINATING"|"TERMINATED"|"SUSPENDED"|"UPDATING"|"STOPPING"|"STOPPED"|"ERROR",
          Type = "PRIMARY"|"STANDBY"
        )
      ),
      DataReplicationSettings = list(
        DataReplication = "NO_REPLICATION"|"PRIMARY_AS_SOURCE",
        RecoverySnapshotTime = as.POSIXct(
          "2015-01-01"
        )
      ),
      StandbyWorkspacesProperties = list(
        list(
          StandbyWorkspaceId = "string",
          DataReplication = "NO_REPLICATION"|"PRIMARY_AS_SOURCE",
          RecoverySnapshotTime = as.POSIXct(
            "2015-01-01"
          )
        )
      )
    )
  )
)

Request syntax

svc$create_workspaces(
  Workspaces = list(
    list(
      DirectoryId = "string",
      UserName = "string",
      BundleId = "string",
      VolumeEncryptionKey = "string",
      UserVolumeEncryptionEnabled = TRUE|FALSE,
      RootVolumeEncryptionEnabled = TRUE|FALSE,
      WorkspaceProperties = list(
        RunningMode = "AUTO_STOP"|"ALWAYS_ON"|"MANUAL",
        RunningModeAutoStopTimeoutInMinutes = 123,
        RootVolumeSizeGib = 123,
        UserVolumeSizeGib = 123,
        ComputeTypeName = "VALUE"|"STANDARD"|"PERFORMANCE"|"POWER"|"GRAPHICS"|"POWERPRO"|"GRAPHICSPRO"|"GRAPHICS_G4DN"|"GRAPHICSPRO_G4DN",
        Protocols = list(
          "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"|"RHEL_8"
      ),
      Tags = list(
        list(
          Key = "string",
          Value = "string"
        )
      ),
      WorkspaceName = "string"
    )
  )
)