Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . workspaces ]

create-workspaces

Description

Creates one or more WorkSpaces.

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

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  create-workspaces
--workspaces <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--workspaces (list)

The WorkSpaces to create. You can specify up to 25 WorkSpaces.

Shorthand Syntax:

DirectoryId=string,UserName=string,BundleId=string,VolumeEncryptionKey=string,UserVolumeEncryptionEnabled=boolean,RootVolumeEncryptionEnabled=boolean,WorkspaceProperties={RunningMode=string,RunningModeAutoStopTimeoutInMinutes=integer,RootVolumeSizeGib=integer,UserVolumeSizeGib=integer,ComputeTypeName=string},Tags=[{Key=string,Value=string},{Key=string,Value=string}] ...

JSON Syntax:

[
  {
    "DirectoryId": "string",
    "UserName": "string",
    "BundleId": "string",
    "VolumeEncryptionKey": "string",
    "UserVolumeEncryptionEnabled": true|false,
    "RootVolumeEncryptionEnabled": true|false,
    "WorkspaceProperties": {
      "RunningMode": "AUTO_STOP"|"ALWAYS_ON",
      "RunningModeAutoStopTimeoutInMinutes": integer,
      "RootVolumeSizeGib": integer,
      "UserVolumeSizeGib": integer,
      "ComputeTypeName": "VALUE"|"STANDARD"|"PERFORMANCE"|"POWER"|"GRAPHICS"
    },
    "Tags": [
      {
        "Key": "string",
        "Value": "string"
      }
      ...
    ]
  }
  ...
]

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Examples

To create a WorkSpace

This example creates a WorkSpace for user jimsmith in the specified directory, from the specified bundle.

Command:

aws workspaces create-workspaces --cli-input-json file://create-workspaces.json

Input:

This is the contents of the create-workspaces.json file:

{
  "Workspaces" : [
    {
      "DirectoryId" : "d-906732325d",
      "UserName" : "jimsmith",
      "BundleId" : "wsb-b0s22j3d7"
    }
  ]
}

Output:

{
  "PendingRequests" : [
    {
      "UserName" : "jimsmith",
      "DirectoryId" : "d-906732325d",
      "State" : "PENDING",
      "WorkspaceId" : "ws-0d4y2sbl5",
      "BundleId" : "wsb-b0s22j3d7"
    }
  ],
  "FailedRequests" : []
}

Output

FailedRequests -> (list)

Information about the WorkSpaces that could not be created.

(structure)

Information about a WorkSpace that could not be created.

WorkspaceRequest -> (structure)

Information about the WorkSpace.

DirectoryId -> (string)

The identifier of the AWS Directory Service directory for the WorkSpace. You can use describe-workspace-directories to list the available directories.

UserName -> (string)

The username of the user for the WorkSpace. This username must exist in the AWS Directory Service directory for the WorkSpace.

BundleId -> (string)

The identifier of the bundle for the WorkSpace. You can use describe-workspace-bundles to list the available bundles.

VolumeEncryptionKey -> (string)

The KMS key used to encrypt data stored on your WorkSpace.

UserVolumeEncryptionEnabled -> (boolean)

Indicates whether the data stored on the user volume is encrypted.

RootVolumeEncryptionEnabled -> (boolean)

Indicates whether the data stored on the root volume is encrypted.

WorkspaceProperties -> (structure)

The WorkSpace properties.

RunningMode -> (string)

The running mode. For more information, see Manage the WorkSpace Running Mode .

RunningModeAutoStopTimeoutInMinutes -> (integer)

The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60 minute intervals.

RootVolumeSizeGib -> (integer)

The size of the root volume.

UserVolumeSizeGib -> (integer)

The size of the user storage.

ComputeTypeName -> (string)

The compute type. For more information, see Amazon WorkSpaces Bundles .

Tags -> (list)

The tags for the WorkSpace.

(structure)

Information about a tag.

Key -> (string)

The key of the tag.

Value -> (string)

The value of the tag.

ErrorCode -> (string)

The error code.

ErrorMessage -> (string)

The textual error message.

PendingRequests -> (list)

Information about the WorkSpaces that were created.

Because this operation is asynchronous, the identifier returned is not immediately available for use with other operations. For example, if you call describe-workspaces before the WorkSpace is created, the information returned can be incomplete.

(structure)

Information about a WorkSpace.

WorkspaceId -> (string)

The identifier of the WorkSpace.

DirectoryId -> (string)

The identifier of the AWS Directory Service directory for the WorkSpace.

UserName -> (string)

The user for the WorkSpace.

IpAddress -> (string)

The IP address of the WorkSpace.

State -> (string)

The operational state of the WorkSpace.

BundleId -> (string)

The identifier of the bundle used to create the WorkSpace.

SubnetId -> (string)

The identifier of the subnet for the WorkSpace.

ErrorMessage -> (string)

If the WorkSpace could not be created, contains a textual error message that describes the failure.

ErrorCode -> (string)

If the WorkSpace could not be created, contains the error code.

ComputerName -> (string)

The name of the WorkSpace, as seen by the operating system.

VolumeEncryptionKey -> (string)

The KMS key used to encrypt data stored on your WorkSpace.

UserVolumeEncryptionEnabled -> (boolean)

Indicates whether the data stored on the user volume is encrypted.

RootVolumeEncryptionEnabled -> (boolean)

Indicates whether the data stored on the root volume is encrypted.

WorkspaceProperties -> (structure)

The properties of the WorkSpace.

RunningMode -> (string)

The running mode. For more information, see Manage the WorkSpace Running Mode .

RunningModeAutoStopTimeoutInMinutes -> (integer)

The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60 minute intervals.

RootVolumeSizeGib -> (integer)

The size of the root volume.

UserVolumeSizeGib -> (integer)

The size of the user storage.

ComputeTypeName -> (string)

The compute type. For more information, see Amazon WorkSpaces Bundles .

ModificationStates -> (list)

The modification states of the WorkSpace.

(structure)

Information about a WorkSpace modification.

Resource -> (string)

The resource.

State -> (string)

The modification state.