ModificationState
Describes a WorkSpace modification.
Contents
Resource
The resource.
Type: String
Valid Values: ROOT_VOLUME | USER_VOLUME | COMPUTE_TYPE Required: No
State
The modification state.
Type: String
Valid Values: UPDATE_INITIATED | UPDATE_IN_PROGRESS Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
Amazon WorkSpaces Service API Reference OperatingSystem
OperatingSystem
The operating system that the image is running.
Contents
Type
The operating system.
Type: String
Valid Values: WINDOWS | LINUX Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
API Version 2015-04-08 164
RebootRequest
RebootRequest
Describes the information used to reboot a WorkSpace.
Contents
WorkspaceId
The identifier of the WorkSpace.
Type: String
Pattern: ^ws-[0-9a-z]{8,63}$
Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
Amazon WorkSpaces Service API Reference RebuildRequest
RebuildRequest
Describes the information used to rebuild a WorkSpace.
Contents
WorkspaceId
The identifier of the WorkSpace.
Type: String
Pattern: ^ws-[0-9a-z]{8,63}$
Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
API Version 2015-04-08 166
RootStorage
RootStorage
Describes the root volume for a WorkSpace bundle.
Contents
Capacity
The size of the root volume.
Type: String
Length Constraints: Minimum length of 1.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
Amazon WorkSpaces Service API Reference SelfservicePermissions
SelfservicePermissions
Describes the self-service permissions for a directory. For more information, see Enable Self-Service WorkSpace Management Capabilities for Your Users.
Contents
ChangeComputeType
Specifies whether users can change the compute type (bundle) for their WorkSpace.
Type: String
Valid Values: ENABLED | DISABLED Required: No
IncreaseVolumeSize
Specifies whether users can increase the volume size of the drives on their WorkSpace.
Type: String
Valid Values: ENABLED | DISABLED Required: No
RebuildWorkspace
Specifies whether users can rebuild the operating system of a WorkSpace to its original state.
Type: String
Valid Values: ENABLED | DISABLED Required: No
RestartWorkspace
Specifies whether users can restart their WorkSpace.
Type: String
Valid Values: ENABLED | DISABLED Required: No
SwitchRunningMode
Specifies whether users can switch the running mode of their WorkSpace.
Type: String
Valid Values: ENABLED | DISABLED Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
API Version 2015-04-08 168
See Also
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
Amazon WorkSpaces Service API Reference Snapshot
Snapshot
Describes a snapshot.
Contents
SnapshotTime
The time when the snapshot was created.
Type: Timestamp Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
API Version 2015-04-08 170
StartRequest
StartRequest
Information used to start a WorkSpace.
Contents
WorkspaceId
The identifier of the WorkSpace.
Type: String
Pattern: ^ws-[0-9a-z]{8,63}$
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
Amazon WorkSpaces Service API Reference StopRequest
StopRequest
Describes the information used to stop a WorkSpace.
Contents
WorkspaceId
The identifier of the WorkSpace.
Type: String
Pattern: ^ws-[0-9a-z]{8,63}$
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
API Version 2015-04-08 172
Tag
Tag
Describes a tag.
Contents
Key
The key of the tag.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 127.
Required: Yes Value
The value of the tag.
Type: String
Length Constraints: Maximum length of 255.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
Amazon WorkSpaces Service API Reference TerminateRequest
TerminateRequest
Describes the information used to terminate a WorkSpace.
Contents
WorkspaceId
The identifier of the WorkSpace.
Type: String
Pattern: ^ws-[0-9a-z]{8,63}$
Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
API Version 2015-04-08 174
UpdateResult
UpdateResult
Describes whether a WorkSpace image needs to be updated with the latest drivers and other components required by Amazon WorkSpaces.
NoteOnly Windows 10 WorkSpace images can be programmatically updated at this time.
Contents
Description
A description of whether updates for the WorkSpace image are pending or available.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: ^[a-zA-Z0-9_./() -]+$
Required: No UpdateAvailable
Indicates whether updated drivers or other components are available for the specified WorkSpace image.
Type: Boolean Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
Amazon WorkSpaces Service API Reference UserStorage
UserStorage
Describes the user volume for a WorkSpace bundle.
Contents
Capacity
The size of the user volume.
Type: String
Length Constraints: Minimum length of 1.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
API Version 2015-04-08 176
Workspace
Workspace
Describes a WorkSpace.
Contents
BundleId
The identifier of the bundle used to create the WorkSpace.
Type: String
Pattern: ^wsb-[0-9a-z]{8,63}$
Required: No ComputerName
The name of the WorkSpace, as seen by the operating system. The format of this name varies. For more information, see Launch a WorkSpace.
Type: String Required: No DirectoryId
The identifier of the AWS Directory Service directory for the WorkSpace.
Type: String
Length Constraints: Minimum length of 10. Maximum length of 65.
Pattern: ^d-[0-9a-f]{8,63}$
Required: No ErrorCode
The error code that is returned if the WorkSpace cannot be created.
Type: String Required: No ErrorMessage
The text of the error message that is returned if the WorkSpace cannot be created.
Type: String Required: No IpAddress
The IP address of the WorkSpace.
Type: String Required: No
Amazon WorkSpaces Service API Reference Contents
Type: Array of ModificationState (p. 163) objects Required: No
RootVolumeEncryptionEnabled
Indicates whether the data stored on the root volume is encrypted.
Type: Boolean Required: No State
The operational state of the WorkSpace.
NoteAfter 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.
Type: String
Valid Values: PENDING | AVAILABLE | IMPAIRED | UNHEALTHY | REBOOTING | STARTING
| REBUILDING | RESTORING | MAINTENANCE | ADMIN_MAINTENANCE | TERMINATING | TERMINATED | SUSPENDED | UPDATING | STOPPING | STOPPED | ERROR
Required: No SubnetId
The identifier of the subnet for the WorkSpace.
Type: String
Length Constraints: Minimum length of 15. Maximum length of 24.
Pattern: ^(subnet-([0-9a-f]{8}|[0-9a-f]{17}))$
Required: No UserName
The user for the WorkSpace.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Required: No
UserVolumeEncryptionEnabled
Indicates whether the data stored on the user volume is encrypted.
Type: Boolean Required: No VolumeEncryptionKey
The symmetric AWS KMS key used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric KMS keys.
Type: String
API Version 2015-04-08 178
See Also
Required: No WorkspaceId
The identifier of the WorkSpace.
Type: String
Pattern: ^ws-[0-9a-z]{8,63}$
Required: No WorkspaceProperties
The properties of the WorkSpace.
Type: WorkspaceProperties (p. 192) object Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
Amazon WorkSpaces Service API Reference WorkspaceAccessProperties
WorkspaceAccessProperties
The device types and operating systems that can be used to access a WorkSpace. For more information, see Amazon WorkSpaces Client Network Requirements.
Contents
DeviceTypeAndroid
Indicates whether users can use Android and Android-compatible Chrome OS devices to access their WorkSpaces.
Type: String
Valid Values: ALLOW | DENY Required: No
DeviceTypeChromeOs
Indicates whether users can use Chromebooks to access their WorkSpaces.
Type: String
Valid Values: ALLOW | DENY Required: No
DeviceTypeIos
Indicates whether users can use iOS devices to access their WorkSpaces.
Type: String
Valid Values: ALLOW | DENY Required: No
DeviceTypeLinux
Indicates whether users can use Linux clients to access their WorkSpaces.
Type: String
Valid Values: ALLOW | DENY Required: No
DeviceTypeOsx
Indicates whether users can use macOS clients to access their WorkSpaces.
Type: String
Valid Values: ALLOW | DENY Required: No
DeviceTypeWeb
Indicates whether users can access their WorkSpaces through a web browser.
Type: String
API Version 2015-04-08 180
See Also
Valid Values: ALLOW | DENY Required: No
DeviceTypeWindows
Indicates whether users can use Windows clients to access their WorkSpaces.
Type: String
Valid Values: ALLOW | DENY Required: No
DeviceTypeZeroClient
Indicates whether users can use zero client devices to access their WorkSpaces.
Type: String
Valid Values: ALLOW | DENY Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
Amazon WorkSpaces Service API Reference WorkspaceBundle
WorkspaceBundle
Describes a WorkSpace bundle.
Contents
BundleId
The identifier of the bundle.
Type: String
Pattern: ^wsb-[0-9a-z]{8,63}$
Required: No ComputeType
The compute type of the bundle. For more information, see Amazon WorkSpaces Bundles.
Type: ComputeType (p. 149) object Required: No
CreationTime
The time when the bundle was created.
Type: Timestamp Required: No Description
The description of the bundle.
Type: String Required: No ImageId
The identifier of the image that was used to create the bundle.
Type: String
Pattern: wsi-[0-9a-z]{9,63}$
Required: No LastUpdatedTime
The last time that the bundle was updated.
Type: Timestamp Required: No Name
The name of the bundle.
Type: String
API Version 2015-04-08 182
See Also
Length Constraints: Minimum length of 1.
Required: No Owner
The owner of the bundle. This is the account identifier of the owner, or AMAZON if the bundle is provided by AWS.
Type: String Required: No RootStorage
The size of the root volume.
Type: RootStorage (p. 167) object Required: No
UserStorage
The size of the user volume.
Type: UserStorage (p. 176) object Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
Amazon WorkSpaces Service API Reference WorkspaceConnectionStatus
WorkspaceConnectionStatus
Describes the connection status of a WorkSpace.
Contents
ConnectionState
The connection state of the WorkSpace. The connection state is unknown if the WorkSpace is stopped.
Type: String
Valid Values: CONNECTED | DISCONNECTED | UNKNOWN Required: No
ConnectionStateCheckTimestamp
The timestamp of the connection status check.
Type: Timestamp Required: No
LastKnownUserConnectionTimestamp
The timestamp of the last known user connection.
Type: Timestamp Required: No WorkspaceId
The identifier of the WorkSpace.
Type: String
Pattern: ^ws-[0-9a-z]{8,63}$
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
API Version 2015-04-08 184
WorkspaceCreationProperties
WorkspaceCreationProperties
Describes the default properties that are used for creating WorkSpaces. For more information, see Update Directory Details for Your WorkSpaces.
Contents
CustomSecurityGroupId
The identifier of your custom security group.
Type: String
Length Constraints: Minimum length of 11. Maximum length of 20.
Pattern: ^(sg-([0-9a-f]{8}|[0-9a-f]{17}))$
Required: No DefaultOu
The default organizational unit (OU) for your WorkSpaces directories. This string must be the full Lightweight Directory Access Protocol (LDAP) distinguished name for the target domain and OU. It must be in the form "OU=value,DC=value,DC=value", where value is any string of characters, and the number of domain components (DCs) is two or more. For example, OU=WorkSpaces_machines,DC=machines,DC=example,DC=com.
Important
• To avoid errors, certain characters in the distinguished name must be escaped. For more information, see Distinguished Names in the Microsoft documentation.
• The API doesn't validate whether the OU exists.
Type: String Required: No EnableInternetAccess
Indicates whether internet access is enabled for your WorkSpaces.
Type: Boolean Required: No
EnableMaintenanceMode
Indicates whether maintenance mode is enabled for your WorkSpaces. For more information, see WorkSpace Maintenance.
Type: Boolean Required: No EnableWorkDocs
Indicates whether Amazon WorkDocs is enabled for your WorkSpaces.
NoteIf WorkDocs is already enabled for a WorkSpaces directory and you disable it, new
WorkSpaces launched in the directory will not have WorkDocs enabled. However, WorkDocs
Amazon WorkSpaces Service API Reference See Also
Disabling Users in the Amazon WorkDocs Administration Guide. To delete a WorkDocs site, see Deleting a Site in the Amazon WorkDocs Administration Guide.
If you enable WorkDocs on a directory that already has existing WorkSpaces, the existing WorkSpaces and any new WorkSpaces that are launched in the directory will have WorkDocs enabled.
Type: Boolean Required: No
UserEnabledAsLocalAdministrator
Indicates whether users are local administrators of their WorkSpaces.
Type: Boolean Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
API Version 2015-04-08 186
WorkspaceDirectory
WorkspaceDirectory
Describes a directory that is used with Amazon WorkSpaces.
Contents
Alias
The directory alias.
Type: String Required: No CustomerUserName
The user name for the service account.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Required: No DirectoryId
The directory identifier.
Type: String
Length Constraints: Minimum length of 10. Maximum length of 65.
Pattern: ^d-[0-9a-f]{8,63}$
Required: No DirectoryName
The name of the directory.
Type: String Required: No DirectoryType
The directory type.
Type: String
Valid Values: SIMPLE_AD | AD_CONNECTOR Required: No
DnsIpAddresses
The IP addresses of the DNS servers for the directory.
Type: Array of strings
Amazon WorkSpaces Service API Reference Contents
IamRoleId
The identifier of the IAM role. This is the role that allows Amazon WorkSpaces to make calls to other services, such as Amazon EC2, on your behalf.
Type: String
Pattern: ^arn:aws:[A-Za-z0-9][A-za-z0-9_/.-]{0,62}:[A-za-z0-9_/.-]{0,63}:[A-za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-za-z0-9_/.-]{0,127}$
Required: No ipGroupIds
The identifiers of the IP access control groups associated with the directory.
Type: Array of strings
Pattern: wsipg-[0-9a-z]{8,63}$
Required: No RegistrationCode
The registration code for the directory. This is the code that users enter in their Amazon WorkSpaces client application to connect to the directory.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 20.
Required: No SelfservicePermissions
The default self-service permissions for WorkSpaces in the directory.
Type: SelfservicePermissions (p. 168) object Required: No
State
The state of the directory's registration with Amazon WorkSpaces. After a directory is deregistered, the DEREGISTERED state is returned very briefly before the directory metadata is cleaned up, so this state is rarely returned. To confirm that a directory is deregistered, check for the directory ID by using DescribeWorkspaceDirectories. If the directory ID isn't returned, then the directory has been successfully deregistered.
Type: String
Valid Values: REGISTERING | REGISTERED | DEREGISTERING | DEREGISTERED | ERROR Required: No
SubnetIds
The identifiers of the subnets used with the directory.
Type: Array of strings
Array Members: Maximum number of 2 items.
Length Constraints: Minimum length of 15. Maximum length of 24.
API Version 2015-04-08 188
See Also
Pattern: ^(subnet-([0-9a-f]{8}|[0-9a-f]{17}))$
Required: No Tenancy
Specifies whether the directory is dedicated or shared. To use Bring Your Own License (BYOL), this value must be set to DEDICATED. For more information, see Bring Your Own Windows Desktop Images.
Type: String
Valid Values: DEDICATED | SHARED Required: No
WorkspaceAccessProperties
The devices and operating systems that users can use to access WorkSpaces.
Type: WorkspaceAccessProperties (p. 180) object Required: No
WorkspaceCreationProperties
The default creation properties for all WorkSpaces in the directory.
Type: DefaultWorkspaceCreationProperties (p. 157) object Required: No
WorkspaceSecurityGroupId
The identifier of the security group that is assigned to new WorkSpaces.
Type: String
Length Constraints: Minimum length of 11. Maximum length of 20.
Pattern: ^(sg-([0-9a-f]{8}|[0-9a-f]{17}))$
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3