<a id="cli-aws-workspaces-create-workspaces"></a>

# create-workspaces

## Description

Creates one or more WorkSpaces.

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

#### NOTE
* 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](http://aws.amazon.com/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?](http://aws.amazon.com/workspaces-family/workspaces/faqs/#:~:text=Can%20I%20switch%20between%20hourly%20and%20monthly%20billing%20on%20WorkSpaces%20Personal%3F)

See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/CreateWorkspaces)

## Synopsis

```
  create-workspaces
--workspaces <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]
```

## Options

`--workspaces` (list) [required]

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

> Constraints:

> * min: `1`
> * max: `25`

> (structure)

> > Describes the information used to create a WorkSpace.

> > DirectoryId -> (string) [required]

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

> > > Constraints:

> > > * min: `10`
> > > * max: `65`
> > > * pattern: `^(d-[0-9a-f]{8,63}$)|(wsd-[0-9a-z]{8,63}$)`

> > UserName -> (string) [required]

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

> > > The username is not case-sensitive, but we recommend matching the case in the Directory Service directory to avoid potential incompatibilities.

> > > The reserved keyword, `[UNDEFINED]` , is used when creating user-decoupled WorkSpaces.

> > > Constraints:

> > > * min: `1`
> > > * max: `63`

> > BundleId -> (string) [required]

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

> > > Constraints:

> > > * pattern: `^wsb-[0-9a-z]{8,63}$`

> > VolumeEncryptionKey -> (string)

> > > The ARN of 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](https://docs.aws.amazon.com/workspaces/latest/adminguide/running-mode.html) .

> > > > #### NOTE
> > > > The `MANUAL` 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](http://aws.amazon.com/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?](http://aws.amazon.com/workspaces-family/workspaces/faqs/#:~:text=Can%20I%20switch%20between%20hourly%20and%20monthly%20billing%20on%20WorkSpaces%20Personal%3F)

> > > > Possible values:

> > > > * `AUTO_STOP`
> > > > * `ALWAYS_ON`
> > > > * `MANUAL`

> > > 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](https://docs.aws.amazon.com/workspaces/latest/adminguide/modify-workspaces.html) .

> > > 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](https://docs.aws.amazon.com/workspaces/latest/adminguide/modify-workspaces.html) .

> > > ComputeTypeName -> (string)

> > > > The compute type. For more information, see [Amazon WorkSpaces Bundles](http://aws.amazon.com/workspaces/details/#Amazon_WorkSpaces_Bundles) .

> > > > Possible values:

> > > > * `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`
> > > > * `GRAPHICS_G7_2XLARGE`
> > > > * `GRAPHICS_G7_4XLARGE`
> > > > * `GRAPHICS_G7_8XLARGE`
> > > > * `GRAPHICS_G7_12XLARGE`

> > > Protocols -> (list)

> > > > The protocol. For more information, see [Protocols for Amazon WorkSpaces](https://docs.aws.amazon.com/workspaces/latest/adminguide/amazon-workspaces-protocols.html) .

> > > > #### NOTE
> > > > * Only available for WorkSpaces created with PCoIP bundles.
> > > > * The `Protocols` property is case sensitive. Ensure you use `PCOIP` or `DCV` (formerly WSP).
> > > > * Unavailable for Windows 7 WorkSpaces and WorkSpaces using GPU-based bundles (Graphics, GraphicsPro, Graphics.g4dn, GraphicsPro.g4dn, Graphics.g6, and Graphics.g7).

> > > > (string)

> > > > > Possible values:

> > > > > * `PCOIP`
> > > > > * `WSP`

> > > OperatingSystemName -> (string)

> > > > The name of the operating system.

> > > > Possible values:

> > > > * `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 -> (structure)

> > > > Indicates the Global Accelerator properties.

> > > > Mode -> (string) [required]

> > > > > Indicates if Global Accelerator for WorkSpaces is enabled, disabled, or the same mode as the associated directory.

> > > > > Possible values:

> > > > > * `ENABLED_AUTO`
> > > > > * `DISABLED`
> > > > > * `INHERITED`

> > > > PreferredProtocol -> (string)

> > > > > Indicates the preferred protocol for Global Accelerator.

> > > > > Possible values:

> > > > > * `TCP`
> > > > > * `NONE`
> > > > > * `INHERITED`

> > > NestedVirtualizationEnabled -> (boolean)

> > > > Specifies whether nested virtualization is enabled for the WorkSpace.

> > > > For more information, see [Nested virtualization for Amazon WorkSpaces](https://docs.aws.amazon.com/workspaces/latest/adminguide/nested-virtualization.html) .

> > Tags -> (list)

> > > The tags for the WorkSpace.

> > > (structure)

> > > > Describes a tag.

> > > > Key -> (string) [required]

> > > > > The key of the tag.

> > > > > Constraints:

> > > > > * min: `1`
> > > > > * max: `127`

> > > > Value -> (string)

> > > > > The value of the tag.

> > > > > Constraints:

> > > > > * max: `255`

> > WorkspaceName -> (string)

> > > The name of the user-decoupled WorkSpace.

> > > #### NOTE
> > > `WorkspaceName` is required if `UserName` is `[UNDEFINED]` for user-decoupled WorkSpaces. `WorkspaceName` is not applicable if `UserName` is specified for user-assigned WorkSpaces.

> > > Constraints:

> > > * pattern: `^[a-zA-Z0-9_()][a-zA-Z0-9_.()-]{1,63}$`

> > Ipv6Address -> (string)

> > > The IPv6 address for the WorkSpace.

> > > Constraints:

> > > * pattern: `^(?:[0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4}|[0-9a-fA-F]{1,4}(?::[0-9a-fA-F]{1,4}){0,6}::[0-9a-fA-F]{1,4}$`

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,Protocols=[string,string],OperatingSystemName=string,GlobalAccelerator={Mode=string,PreferredProtocol=string},NestedVirtualizationEnabled=boolean},Tags=[{Key=string,Value=string},{Key=string,Value=string}],WorkspaceName=string,Ipv6Address=string ...
```

JSON Syntax:

```json
[
  {
    "DirectoryId": "string",
    "UserName": "string",
    "BundleId": "string",
    "VolumeEncryptionKey": "string",
    "UserVolumeEncryptionEnabled": true|false,
    "RootVolumeEncryptionEnabled": true|false,
    "WorkspaceProperties": {
      "RunningMode": "AUTO_STOP"|"ALWAYS_ON"|"MANUAL",
      "RunningModeAutoStopTimeoutInMinutes": integer,
      "RootVolumeSizeGib": integer,
      "UserVolumeSizeGib": integer,
      "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"|"GRAPHICS_G7_2XLARGE"|"GRAPHICS_G7_4XLARGE"|"GRAPHICS_G7_8XLARGE"|"GRAPHICS_G7_12XLARGE",
      "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",
        "PreferredProtocol": "TCP"|"NONE"|"INHERITED"
      },
      "NestedVirtualizationEnabled": true|false
    },
    "Tags": [
      {
        "Key": "string",
        "Value": "string"
      }
      ...
    ],
    "WorkspaceName": "string",
    "Ipv6Address": "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.

## Global Options

`--debug` (boolean)

Turn on debug logging.

`--endpoint-url` (string)

Override command’s default URL with the given URL.

`--no-verify-ssl` (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

`--no-paginate` (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

`--output` (string)

The formatting style for command output.

* json
* text
* table
* yaml
* yaml-stream
* off

`--query` (string)

A JMESPath query to use in filtering the response data.

`--profile` (string)

Use a specific profile from your credential file.

`--region` (string)

The region to use. Overrides config/env settings.

`--version` (string)

Display the version of this tool.

`--color` (string)

Turn on/off color output.

* on
* off
* auto

`--no-sign-request` (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

`--ca-bundle` (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

`--cli-read-timeout` (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

`--cli-connect-timeout` (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

`--cli-binary-format` (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob `fileb://` will always be treated as binary and use the file contents directly regardless of the `cli-binary-format` setting. When using `file://` the file contents will need to properly formatted for the configured `cli-binary-format`.

* base64
* raw-in-base64-out

`--no-cli-pager` (boolean)

Disable cli pager for output.

`--cli-auto-prompt` (boolean)

Automatically prompt for CLI input parameters.

`--no-cli-auto-prompt` (boolean)

Disable automatically prompt for CLI input parameters.

`--cli-error-format` (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

* legacy
* json
* yaml
* text
* table
* enhanced

## Examples

#### NOTE
To use the following examples, you must have the AWS CLI installed and configured. See the [Getting started guide](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html) 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](https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-quoting-strings.html) in the *AWS CLI User Guide* .

**Example 1: To create an AlwaysOn WorkSpace**

The following `create-workspaces` example creates an AlwaysOn WorkSpace for the specified user, using the specified directory and bundle.

```bash
aws workspaces create-workspaces \
    --workspaces DirectoryId=d-926722edaf,UserName=Mateo,BundleId=wsb-0zsvgp8fc
```

Output:

```json
{
    "FailedRequests": [],
    "PendingRequests": [
        {
            "WorkspaceId": "ws-kcqms853t",
            "DirectoryId": "d-926722edaf",
            "UserName": "Mateo",
            "State": "PENDING",
            "BundleId": "wsb-0zsvgp8fc"
        }
    ]
}
```

**Example 2: To create an AutoStop WorkSpace**

The following `create-workspaces` example creates an AutoStop WorkSpace for the specified user, using the specified directory and bundle.

```bash
aws workspaces create-workspaces \
    --workspaces DirectoryId=d-926722edaf,UserName=Mary,BundleId=wsb-0zsvgp8fc,WorkspaceProperties={RunningMode=AUTO_STOP}
```

Output:

```json
{
    "FailedRequests": [],
    "PendingRequests": [
        {
            "WorkspaceId": "ws-dk1xzr417",
            "DirectoryId": "d-926722edaf",
            "UserName": "Mary",
            "State": "PENDING",
            "BundleId": "wsb-0zsvgp8fc"
        }
    ]
}
```

**Example 3: To create a user-decoupled WorkSpace**

The following `create-workspaces` example creates a user-decoupled WorkSpace by setting the username to `[UNDEFINED]`, and specifying a WorkSpace name, directory ID, and bundle ID.

```bash
aws workspaces create-workspaces \
    --workspaces DirectoryId=d-926722edaf,UserName='"[UNDEFINED]"',WorkspaceName=MaryWorkspace1,BundleId=wsb-0zsvgp8fc,WorkspaceProperties={RunningMode=ALWAYS_ON}
```

Output:

```json
{
    "FailedRequests": [],
    "PendingRequests": [
        {
            "WorkspaceId": "ws-abcd1234",
            "DirectoryId": "d-926722edaf",
            "UserName": "[UNDEFINED]",
            "State": "PENDING",
            "BundleId": "wsb-0zsvgp8fc",
            "WorkspaceName": "MaryWorkspace1"
        }
    ]
}
```

For more information, see [Launch a virtual desktop](https://docs.aws.amazon.com/workspaces/latest/adminguide/launch-workspaces-tutorials.html) in the *Amazon WorkSpaces Administration Guide*.

## 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) [required]

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

> > > > Constraints:

> > > > * min: `10`
> > > > * max: `65`
> > > > * pattern: `^(d-[0-9a-f]{8,63}$)|(wsd-[0-9a-z]{8,63}$)`

> > > UserName -> (string) [required]

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

> > > > The username is not case-sensitive, but we recommend matching the case in the Directory Service directory to avoid potential incompatibilities.

> > > > The reserved keyword, `[UNDEFINED]` , is used when creating user-decoupled WorkSpaces.

> > > > Constraints:

> > > > * min: `1`
> > > > * max: `63`

> > > BundleId -> (string) [required]

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

> > > > Constraints:

> > > > * pattern: `^wsb-[0-9a-z]{8,63}$`

> > > VolumeEncryptionKey -> (string)

> > > > The ARN of 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](https://docs.aws.amazon.com/workspaces/latest/adminguide/running-mode.html) .

> > > > > #### NOTE
> > > > > The `MANUAL` 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](http://aws.amazon.com/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?](http://aws.amazon.com/workspaces-family/workspaces/faqs/#:~:text=Can%20I%20switch%20between%20hourly%20and%20monthly%20billing%20on%20WorkSpaces%20Personal%3F)

> > > > > Possible values:

> > > > > * `AUTO_STOP`
> > > > > * `ALWAYS_ON`
> > > > > * `MANUAL`

> > > > 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](https://docs.aws.amazon.com/workspaces/latest/adminguide/modify-workspaces.html) .

> > > > 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](https://docs.aws.amazon.com/workspaces/latest/adminguide/modify-workspaces.html) .

> > > > ComputeTypeName -> (string)

> > > > > The compute type. For more information, see [Amazon WorkSpaces Bundles](http://aws.amazon.com/workspaces/details/#Amazon_WorkSpaces_Bundles) .

> > > > > Possible values:

> > > > > * `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`
> > > > > * `GRAPHICS_G7_2XLARGE`
> > > > > * `GRAPHICS_G7_4XLARGE`
> > > > > * `GRAPHICS_G7_8XLARGE`
> > > > > * `GRAPHICS_G7_12XLARGE`

> > > > Protocols -> (list)

> > > > > The protocol. For more information, see [Protocols for Amazon WorkSpaces](https://docs.aws.amazon.com/workspaces/latest/adminguide/amazon-workspaces-protocols.html) .

> > > > > #### NOTE
> > > > > * Only available for WorkSpaces created with PCoIP bundles.
> > > > > * The `Protocols` property is case sensitive. Ensure you use `PCOIP` or `DCV` (formerly WSP).
> > > > > * Unavailable for Windows 7 WorkSpaces and WorkSpaces using GPU-based bundles (Graphics, GraphicsPro, Graphics.g4dn, GraphicsPro.g4dn, Graphics.g6, and Graphics.g7).

> > > > > (string)

> > > > > > Possible values:

> > > > > > * `PCOIP`
> > > > > > * `WSP`

> > > > OperatingSystemName -> (string)

> > > > > The name of the operating system.

> > > > > Possible values:

> > > > > * `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 -> (structure)

> > > > > Indicates the Global Accelerator properties.

> > > > > Mode -> (string) [required]

> > > > > > Indicates if Global Accelerator for WorkSpaces is enabled, disabled, or the same mode as the associated directory.

> > > > > > Possible values:

> > > > > > * `ENABLED_AUTO`
> > > > > > * `DISABLED`
> > > > > > * `INHERITED`

> > > > > PreferredProtocol -> (string)

> > > > > > Indicates the preferred protocol for Global Accelerator.

> > > > > > Possible values:

> > > > > > * `TCP`
> > > > > > * `NONE`
> > > > > > * `INHERITED`

> > > > NestedVirtualizationEnabled -> (boolean)

> > > > > Specifies whether nested virtualization is enabled for the WorkSpace.

> > > > > For more information, see [Nested virtualization for Amazon WorkSpaces](https://docs.aws.amazon.com/workspaces/latest/adminguide/nested-virtualization.html) .

> > > Tags -> (list)

> > > > The tags for the WorkSpace.

> > > > (structure)

> > > > > Describes a tag.

> > > > > Key -> (string) [required]

> > > > > > The key of the tag.

> > > > > > Constraints:

> > > > > > * min: `1`
> > > > > > * max: `127`

> > > > > Value -> (string)

> > > > > > The value of the tag.

> > > > > > Constraints:

> > > > > > * max: `255`

> > > WorkspaceName -> (string)

> > > > The name of the user-decoupled WorkSpace.

> > > > #### NOTE
> > > > `WorkspaceName` is required if `UserName` is `[UNDEFINED]` for user-decoupled WorkSpaces. `WorkspaceName` is not applicable if `UserName` is specified for user-assigned WorkSpaces.

> > > > Constraints:

> > > > * pattern: `^[a-zA-Z0-9_()][a-zA-Z0-9_.()-]{1,63}$`

> > > Ipv6Address -> (string)

> > > > The IPv6 address for the WorkSpace.

> > > > Constraints:

> > > > * pattern: `^(?:[0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4}|[0-9a-fA-F]{1,4}(?::[0-9a-fA-F]{1,4}){0,6}::[0-9a-fA-F]{1,4}$`

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

> > > Constraints:

> > > * pattern: `^ws-[0-9a-z]{8,63}$`

> > DirectoryId -> (string)

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

> > > Constraints:

> > > * min: `10`
> > > * max: `65`
> > > * pattern: `^(d-[0-9a-f]{8,63}$)|(wsd-[0-9a-z]{8,63}$)`

> > UserName -> (string)

> > > The user for the WorkSpace.

> > > Constraints:

> > > * min: `1`
> > > * max: `63`

> > IpAddress -> (string)

> > > The IP address of the WorkSpace.

> > Ipv6Address -> (string)

> > > The IPv6 address of the WorkSpace.

> > > Constraints:

> > > * pattern: `^(?:[0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4}|[0-9a-fA-F]{1,4}(?::[0-9a-fA-F]{1,4}){0,6}::[0-9a-fA-F]{1,4}$`

> > State -> (string)

> > > The operational state of the WorkSpace.

> > > * `PENDING` – The WorkSpace is in a waiting state (for example, the WorkSpace is being created).
> > > * `AVAILABLE` – The WorkSpace is running and has passed the health checks.
> > > * `IMPAIRED` – Refer to `UNHEALTHY` state.
> > > * `UNHEALTHY` – The WorkSpace is not responding to health checks.
> > > * `REBOOTING` – The WorkSpace is being rebooted (restarted).
> > > * `STARTING` – The WorkSpace is starting up and health checks are being run.
> > > * `REBUILDING` – The WorkSpace is being rebuilt.
> > > * `RESTORING` – The WorkSpace is being restored.
> > > * `MAINTENANCE` – The WorkSpace is undergoing scheduled maintenance by Amazon Web Services.
> > > * `ADMIN_MAINTENANCE` – The WorkSpace is undergoing maintenance by the WorkSpaces administrator.
> > > * `TERMINATING` – The WorkSpace is being deleted.
> > > * `TERMINATED` – The WorkSpace has been deleted.
> > > * `SUSPENDED` – The WorkSpace has been suspended for image creation.
> > > * `UPDATING` – The WorkSpace is undergoing an update.
> > > * `STOPPING` – The WorkSpace is being stopped.
> > > * `STOPPED` – The WorkSpace has been stopped.
> > > * `ERROR` – The WorkSpace is an error state (for example, an error occurred during startup).

> > > #### 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](https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaces.html) . If the WorkSpace ID isn’t returned, then the WorkSpace has been successfully terminated.

> > > Possible values:

> > > * `PENDING`
> > > * `AVAILABLE`
> > > * `IMPAIRED`
> > > * `UNHEALTHY`
> > > * `REBOOTING`
> > > * `STARTING`
> > > * `REBUILDING`
> > > * `RESTORING`
> > > * `MAINTENANCE`
> > > * `ADMIN_MAINTENANCE`
> > > * `TERMINATING`
> > > * `TERMINATED`
> > > * `SUSPENDED`
> > > * `UPDATING`
> > > * `STOPPING`
> > > * `STOPPED`
> > > * `ERROR`

> > BundleId -> (string)

> > > The identifier of the bundle used to create the WorkSpace.

> > > Constraints:

> > > * pattern: `^wsb-[0-9a-z]{8,63}$`

> > SubnetId -> (string)

> > > The identifier of the subnet for the WorkSpace.

> > > Constraints:

> > > * min: `15`
> > > * max: `24`
> > > * pattern: `^(subnet-([0-9a-f]{8}|[0-9a-f]{17}))$`

> > 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](https://docs.aws.amazon.com/workspaces/latest/adminguide/launch-workspaces-tutorials.html) .

> > VolumeEncryptionKey -> (string)

> > > The ARN of 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.

> > WorkspaceName -> (string)

> > > The name of the user-decoupled WorkSpace.

> > > Constraints:

> > > * pattern: `^[a-zA-Z0-9_()][a-zA-Z0-9_.()-]{1,63}$`

> > WorkspaceProperties -> (structure)

> > > The properties of the WorkSpace.

> > > RunningMode -> (string)

> > > > The running mode. For more information, see [Manage the WorkSpace Running Mode](https://docs.aws.amazon.com/workspaces/latest/adminguide/running-mode.html) .

> > > > #### NOTE
> > > > The `MANUAL` 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](http://aws.amazon.com/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?](http://aws.amazon.com/workspaces-family/workspaces/faqs/#:~:text=Can%20I%20switch%20between%20hourly%20and%20monthly%20billing%20on%20WorkSpaces%20Personal%3F)

> > > > Possible values:

> > > > * `AUTO_STOP`
> > > > * `ALWAYS_ON`
> > > > * `MANUAL`

> > > 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](https://docs.aws.amazon.com/workspaces/latest/adminguide/modify-workspaces.html) .

> > > 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](https://docs.aws.amazon.com/workspaces/latest/adminguide/modify-workspaces.html) .

> > > ComputeTypeName -> (string)

> > > > The compute type. For more information, see [Amazon WorkSpaces Bundles](http://aws.amazon.com/workspaces/details/#Amazon_WorkSpaces_Bundles) .

> > > > Possible values:

> > > > * `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`
> > > > * `GRAPHICS_G7_2XLARGE`
> > > > * `GRAPHICS_G7_4XLARGE`
> > > > * `GRAPHICS_G7_8XLARGE`
> > > > * `GRAPHICS_G7_12XLARGE`

> > > Protocols -> (list)

> > > > The protocol. For more information, see [Protocols for Amazon WorkSpaces](https://docs.aws.amazon.com/workspaces/latest/adminguide/amazon-workspaces-protocols.html) .

> > > > #### NOTE
> > > > * Only available for WorkSpaces created with PCoIP bundles.
> > > > * The `Protocols` property is case sensitive. Ensure you use `PCOIP` or `DCV` (formerly WSP).
> > > > * Unavailable for Windows 7 WorkSpaces and WorkSpaces using GPU-based bundles (Graphics, GraphicsPro, Graphics.g4dn, GraphicsPro.g4dn, Graphics.g6, and Graphics.g7).

> > > > (string)

> > > > > Possible values:

> > > > > * `PCOIP`
> > > > > * `WSP`

> > > OperatingSystemName -> (string)

> > > > The name of the operating system.

> > > > Possible values:

> > > > * `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 -> (structure)

> > > > Indicates the Global Accelerator properties.

> > > > Mode -> (string) [required]

> > > > > Indicates if Global Accelerator for WorkSpaces is enabled, disabled, or the same mode as the associated directory.

> > > > > Possible values:

> > > > > * `ENABLED_AUTO`
> > > > > * `DISABLED`
> > > > > * `INHERITED`

> > > > PreferredProtocol -> (string)

> > > > > Indicates the preferred protocol for Global Accelerator.

> > > > > Possible values:

> > > > > * `TCP`
> > > > > * `NONE`
> > > > > * `INHERITED`

> > > NestedVirtualizationEnabled -> (boolean)

> > > > Specifies whether nested virtualization is enabled for the WorkSpace.

> > > > For more information, see [Nested virtualization for Amazon WorkSpaces](https://docs.aws.amazon.com/workspaces/latest/adminguide/nested-virtualization.html) .

> > ModificationStates -> (list)

> > > The modification states of the WorkSpace.

> > > (structure)

> > > > Describes a WorkSpace modification.

> > > > Resource -> (string)

> > > > > The WorkSpace property being modified.

> > > > > Possible values:

> > > > > * `ROOT_VOLUME`
> > > > > * `USER_VOLUME`
> > > > > * `COMPUTE_TYPE`
> > > > > * `PROTOCOL`
> > > > > * `NESTED_VIRTUALIZATION`

> > > > State -> (string)

> > > > > The modification state.

> > > > > Possible values:

> > > > > * `UPDATE_INITIATED`
> > > > > * `UPDATE_IN_PROGRESS`
> > > > > * `UPDATE_FAILED`

> > RelatedWorkspaces -> (list)

> > > The standby WorkSpace or primary WorkSpace related to the specified WorkSpace.

> > > (structure)

> > > > Describes the related WorkSpace. The related WorkSpace could be a standby WorkSpace or primary WorkSpace related to the specified WorkSpace.

> > > > WorkspaceId -> (string)

> > > > > The identifier of the related WorkSpace.

> > > > > Constraints:

> > > > > * pattern: `^ws-[0-9a-z]{8,63}$`

> > > > Region -> (string)

> > > > > The Region of the related WorkSpace.

> > > > > Constraints:

> > > > > * min: `1`
> > > > > * max: `31`
> > > > > * pattern: `^[-0-9a-z]{1,31}$`

> > > > State -> (string)

> > > > > Indicates the state of the WorkSpace.

> > > > > Possible values:

> > > > > * `PENDING`
> > > > > * `AVAILABLE`
> > > > > * `IMPAIRED`
> > > > > * `UNHEALTHY`
> > > > > * `REBOOTING`
> > > > > * `STARTING`
> > > > > * `REBUILDING`
> > > > > * `RESTORING`
> > > > > * `MAINTENANCE`
> > > > > * `ADMIN_MAINTENANCE`
> > > > > * `TERMINATING`
> > > > > * `TERMINATED`
> > > > > * `SUSPENDED`
> > > > > * `UPDATING`
> > > > > * `STOPPING`
> > > > > * `STOPPED`
> > > > > * `ERROR`

> > > > Type -> (string)

> > > > > Indicates the type of WorkSpace.

> > > > > Possible values:

> > > > > * `PRIMARY`
> > > > > * `STANDBY`

> > DataReplicationSettings -> (structure)

> > > Indicates the settings of the data replication.

> > > DataReplication -> (string)

> > > > Indicates whether data replication is enabled, and if enabled, the type of data replication.

> > > > Possible values:

> > > > * `NO_REPLICATION`
> > > > * `PRIMARY_AS_SOURCE`

> > > RecoverySnapshotTime -> (timestamp)

> > > > The date and time at which the last successful snapshot was taken of the primary WorkSpace used for replicating data.

> > StandbyWorkspacesProperties -> (list)

> > > The properties of the standby WorkSpace

> > > (structure)

> > > > Describes the properties of the related standby WorkSpaces.

> > > > StandbyWorkspaceId -> (string)

> > > > > The identifier of the standby WorkSpace

> > > > > Constraints:

> > > > > * pattern: `^ws-[0-9a-z]{8,63}$`

> > > > DataReplication -> (string)

> > > > > Indicates whether data replication is enabled, and if enabled, the type of data replication.

> > > > > Possible values:

> > > > > * `NO_REPLICATION`
> > > > > * `PRIMARY_AS_SOURCE`

> > > > RecoverySnapshotTime -> (timestamp)

> > > > > The date and time at which the last successful snapshot was taken of the primary WorkSpace used for replicating data.
