create-workspaces¶

Description¶

Creates one or more WorkSpaces.

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

Synopsis¶

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

Options¶

--workspaces (list)

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

(structure)

Describes the information used to create a WorkSpace.

DirectoryId -> (string)

The identifier of the Directory Service directory for the WorkSpace. You can use DescribeWorkspaceDirectories to list the available directories.

UserName -> (string)

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

BundleId -> (string)

The identifier of the bundle for the WorkSpace. You can use DescribeWorkspaceBundles to list the available bundles.

VolumeEncryptionKey -> (string)

The symmetric KMS key used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric KMS keys.

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. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace .

UserVolumeSizeGib -> (integer)

The size of the user storage. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace .

ComputeTypeName -> (string)

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

Tags -> (list)

The tags for the WorkSpace.

(structure)

Describes a tag.

Key -> (string)

The key of the tag.

Value -> (string)

The value of the tag.

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"|"POWERPRO"|"GRAPHICSPRO"|"GRAPHICS_G4DN"|"GRAPHICSPRO_G4DN"
    },
    "Tags": [
      {
        "Key": "string",
        "Value": "string"
      }
      ...
    ]
  }
  ...
]

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Examples¶

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

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)

Describes a WorkSpace that cannot be created.

WorkspaceRequest -> (structure)

Information about the WorkSpace.

DirectoryId -> (string)

The identifier of the Directory Service directory for the WorkSpace. You can use DescribeWorkspaceDirectories to list the available directories.

UserName -> (string)

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

BundleId -> (string)

The identifier of the bundle for the WorkSpace. You can use DescribeWorkspaceBundles to list the available bundles.

VolumeEncryptionKey -> (string)

The symmetric KMS key used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric KMS keys.

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. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace .

UserVolumeSizeGib -> (integer)

The size of the user storage. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace .

ComputeTypeName -> (string)

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

Tags -> (list)

The tags for the WorkSpace.

(structure)

Describes a tag.

Key -> (string)

The key of the tag.

Value -> (string)

The value of the tag.

ErrorCode -> (string)

The error code that is returned if the WorkSpace cannot be created.

ErrorMessage -> (string)

The text of the error message that is returned if the WorkSpace cannot be created.

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 DescribeWorkspaces before the WorkSpace is created, the information returned can be incomplete.

(structure)

Describes a WorkSpace.

WorkspaceId -> (string)

The identifier of the WorkSpace.

DirectoryId -> (string)

The identifier of the 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.

Note

After a WorkSpace is terminated, the TERMINATED state is returned only briefly before the WorkSpace directory metadata is cleaned up, so this state is rarely returned. To confirm that a WorkSpace is terminated, check for the WorkSpace ID by using DescribeWorkSpaces . If the WorkSpace ID isn’t returned, then the WorkSpace has been successfully terminated.

BundleId -> (string)

The identifier of the bundle used to create the WorkSpace.

SubnetId -> (string)

The identifier of the subnet for the WorkSpace.

ErrorMessage -> (string)

The text of the error message that is returned if the WorkSpace cannot be created.

ErrorCode -> (string)

The error code that is returned if the WorkSpace cannot be created.

ComputerName -> (string)

The name of the WorkSpace, as seen by the operating system. The format of this name varies. For more information, see Launch a WorkSpace .

VolumeEncryptionKey -> (string)

The symmetric KMS key used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric KMS keys.

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. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace .

UserVolumeSizeGib -> (integer)

The size of the user storage. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace .

ComputeTypeName -> (string)

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

ModificationStates -> (list)

The modification states of the WorkSpace.

(structure)

Describes a WorkSpace modification.

Resource -> (string)

The resource.

State -> (string)

The modification state.

Table of Contents

Feedback

User Guide

create-workspaces¶

Description¶

Synopsis¶

Options¶

Examples¶

Output¶