1{ 2 "version": "2.0", 3 "service": "<fullname>Amazon WorkSpaces Service</fullname> <p>Amazon WorkSpaces enables you to provision virtual, cloud-based Microsoft Windows and Amazon Linux desktops for your users.</p>", 4 "operations": { 5 "AssociateIpGroups": "<p>Associates the specified IP access control group with the specified directory.</p>", 6 "AuthorizeIpRules": "<p>Adds one or more rules to the specified IP access control group.</p> <p>This action gives users permission to access their WorkSpaces from the CIDR address ranges specified in the rules.</p>", 7 "CopyWorkspaceImage": "<p>Copies the specified image from the specified Region to the current Region.</p>", 8 "CreateIpGroup": "<p>Creates an IP access control group.</p> <p>An IP access control group provides you with the ability to control the IP addresses from which users are allowed to access their WorkSpaces. To specify the CIDR address ranges, add rules to your IP access control group and then associate the group with your directory. You can add rules when you create the group or at any time using <a>AuthorizeIpRules</a>.</p> <p>There is a default IP access control group associated with your directory. If you don't associate an IP access control group with your directory, the default group is used. The default group includes a default rule that allows users to access their WorkSpaces from anywhere. You cannot modify the default IP access control group for your directory.</p>", 9 "CreateTags": "<p>Creates the specified tags for the specified WorkSpaces resource.</p>", 10 "CreateWorkspaces": "<p>Creates one or more WorkSpaces.</p> <p>This operation is asynchronous and returns before the WorkSpaces are created.</p>", 11 "DeleteIpGroup": "<p>Deletes the specified IP access control group.</p> <p>You cannot delete an IP access control group that is associated with a directory.</p>", 12 "DeleteTags": "<p>Deletes the specified tags from the specified WorkSpaces resource.</p>", 13 "DeleteWorkspaceImage": "<p>Deletes the specified image from your account. To delete an image, you must first delete any bundles that are associated with the image and un-share the image if it is shared with other accounts. </p>", 14 "DeregisterWorkspaceDirectory": "<p>Deregisters the specified directory. This operation is asynchronous and returns before the WorkSpace directory is deregistered. If any WorkSpaces are registered to this directory, you must remove them before you can deregister the directory.</p>", 15 "DescribeAccount": "<p>Retrieves a list that describes the configuration of Bring Your Own License (BYOL) for the specified account.</p>", 16 "DescribeAccountModifications": "<p>Retrieves a list that describes modifications to the configuration of Bring Your Own License (BYOL) for the specified account.</p>", 17 "DescribeClientProperties": "<p>Retrieves a list that describes one or more specified Amazon WorkSpaces clients.</p>", 18 "DescribeIpGroups": "<p>Describes one or more of your IP access control groups.</p>", 19 "DescribeTags": "<p>Describes the specified tags for the specified WorkSpaces resource.</p>", 20 "DescribeWorkspaceBundles": "<p>Retrieves a list that describes the available WorkSpace bundles.</p> <p>You can filter the results using either bundle ID or owner, but not both.</p>", 21 "DescribeWorkspaceDirectories": "<p>Describes the available directories that are registered with Amazon WorkSpaces.</p>", 22 "DescribeWorkspaceImages": "<p>Retrieves a list that describes one or more specified images, if the image identifiers are provided. Otherwise, all images in the account are described. </p>", 23 "DescribeWorkspaceSnapshots": "<p>Describes the snapshots for the specified WorkSpace.</p>", 24 "DescribeWorkspaces": "<p>Describes the specified WorkSpaces.</p> <p>You can filter the results by using the bundle identifier, directory identifier, or owner, but you can specify only one filter at a time.</p>", 25 "DescribeWorkspacesConnectionStatus": "<p>Describes the connection status of the specified WorkSpaces.</p>", 26 "DisassociateIpGroups": "<p>Disassociates the specified IP access control group from the specified directory.</p>", 27 "ImportWorkspaceImage": "<p>Imports the specified Windows 7 or Windows 10 Bring Your Own License (BYOL) image into Amazon WorkSpaces. The image must be an already licensed EC2 image that is in your AWS account, and you must own the image. </p>", 28 "ListAvailableManagementCidrRanges": "<p>Retrieves a list of IP address ranges, specified as IPv4 CIDR blocks, that you can use for the network management interface when you enable Bring Your Own License (BYOL). </p> <p>The management network interface is connected to a secure Amazon WorkSpaces management network. It is used for interactive streaming of the WorkSpace desktop to Amazon WorkSpaces clients, and to allow Amazon WorkSpaces to manage the WorkSpace.</p>", 29 "ModifyAccount": "<p>Modifies the configuration of Bring Your Own License (BYOL) for the specified account.</p>", 30 "ModifyClientProperties": "<p>Modifies the properties of the specified Amazon WorkSpaces clients.</p>", 31 "ModifySelfservicePermissions": "<p>Modifies the self-service WorkSpace management capabilities for your users. For more information, see <a href=\"https://docs.aws.amazon.com/workspaces/latest/adminguide/enable-user-self-service-workspace-management.html\">Enable Self-Service WorkSpace Management Capabilities for Your Users</a>.</p>", 32 "ModifyWorkspaceAccessProperties": "<p>Specifies which devices and operating systems users can use to access their Workspaces. For more information, see <a href=\"https://docs.aws.amazon.com/workspaces/latest/adminguide/update-directory-details.html#control-device-access\"> Control Device Access</a>.</p>", 33 "ModifyWorkspaceCreationProperties": "<p>Modify the default properties used to create WorkSpaces.</p>", 34 "ModifyWorkspaceProperties": "<p>Modifies the specified WorkSpace properties.</p>", 35 "ModifyWorkspaceState": "<p>Sets the state of the specified WorkSpace.</p> <p>To maintain a WorkSpace without being interrupted, set the WorkSpace state to <code>ADMIN_MAINTENANCE</code>. WorkSpaces in this state do not respond to requests to reboot, stop, start, rebuild, or restore. An AutoStop WorkSpace in this state is not stopped. Users cannot log into a WorkSpace in the <code>ADMIN_MAINTENANCE</code> state.</p>", 36 "RebootWorkspaces": "<p>Reboots the specified WorkSpaces.</p> <p>You cannot reboot a WorkSpace unless its state is <code>AVAILABLE</code> or <code>UNHEALTHY</code>.</p> <p>This operation is asynchronous and returns before the WorkSpaces have rebooted.</p>", 37 "RebuildWorkspaces": "<p>Rebuilds the specified WorkSpace.</p> <p>You cannot rebuild a WorkSpace unless its state is <code>AVAILABLE</code>, <code>ERROR</code>, or <code>UNHEALTHY</code>.</p> <p>Rebuilding a WorkSpace is a potentially destructive action that can result in the loss of data. For more information, see <a href=\"https://docs.aws.amazon.com/workspaces/latest/adminguide/reset-workspace.html\">Rebuild a WorkSpace</a>.</p> <p>This operation is asynchronous and returns before the WorkSpaces have been completely rebuilt.</p>", 38 "RegisterWorkspaceDirectory": "<p>Registers the specified directory. This operation is asynchronous and returns before the WorkSpace directory is registered. If this is the first time you are registering a directory, you will need to create the workspaces_DefaultRole role before you can register a directory. For more information, see <a href=\"https://docs.aws.amazon.com/workspaces/latest/adminguide/workspaces-access-control.html#create-default-role\"> Creating the workspaces_DefaultRole Role</a>.</p>", 39 "RestoreWorkspace": "<p>Restores the specified WorkSpace to its last known healthy state.</p> <p>You cannot restore a WorkSpace unless its state is <code> AVAILABLE</code>, <code>ERROR</code>, or <code>UNHEALTHY</code>.</p> <p>Restoring a WorkSpace is a potentially destructive action that can result in the loss of data. For more information, see <a href=\"https://docs.aws.amazon.com/workspaces/latest/adminguide/restore-workspace.html\">Restore a WorkSpace</a>.</p> <p>This operation is asynchronous and returns before the WorkSpace is completely restored.</p>", 40 "RevokeIpRules": "<p>Removes one or more rules from the specified IP access control group.</p>", 41 "StartWorkspaces": "<p>Starts the specified WorkSpaces.</p> <p>You cannot start a WorkSpace unless it has a running mode of <code>AutoStop</code> and a state of <code>STOPPED</code>.</p>", 42 "StopWorkspaces": "<p> Stops the specified WorkSpaces.</p> <p>You cannot stop a WorkSpace unless it has a running mode of <code>AutoStop</code> and a state of <code>AVAILABLE</code>, <code>IMPAIRED</code>, <code>UNHEALTHY</code>, or <code>ERROR</code>.</p>", 43 "TerminateWorkspaces": "<p>Terminates the specified WorkSpaces.</p> <p>Terminating a WorkSpace is a permanent action and cannot be undone. The user's data is destroyed. If you need to archive any user data, contact Amazon Web Services before terminating the WorkSpace.</p> <p>You can terminate a WorkSpace that is in any state except <code>SUSPENDED</code>.</p> <p>This operation is asynchronous and returns before the WorkSpaces have been completely terminated.</p>", 44 "UpdateRulesOfIpGroup": "<p>Replaces the current rules of the specified IP access control group with the specified rules.</p>" 45 }, 46 "shapes": { 47 "ARN": { 48 "base": null, 49 "refs": { 50 "WorkspaceDirectory$IamRoleId": "<p>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.</p>" 51 } 52 }, 53 "AccessDeniedException": { 54 "base": "<p>The user is not authorized to access a resource.</p>", 55 "refs": { 56 } 57 }, 58 "AccessPropertyValue": { 59 "base": null, 60 "refs": { 61 "WorkspaceAccessProperties$DeviceTypeWindows": "<p>Indicates whether users can use Windows clients to access their WorkSpaces. To restrict WorkSpaces access to trusted devices (also known as managed devices) with valid certificates, specify a value of <code>TRUST</code>. For more information, see <a href=\"https://docs.aws.amazon.com/workspaces/latest/adminguide/trusted-devices.html\">Restrict WorkSpaces Access to Trusted Devices</a>. </p>", 62 "WorkspaceAccessProperties$DeviceTypeOsx": "<p>Indicates whether users can use macOS clients to access their WorkSpaces. To restrict WorkSpaces access to trusted devices (also known as managed devices) with valid certificates, specify a value of <code>TRUST</code>. For more information, see <a href=\"https://docs.aws.amazon.com/workspaces/latest/adminguide/trusted-devices.html\">Restrict WorkSpaces Access to Trusted Devices</a>. </p>", 63 "WorkspaceAccessProperties$DeviceTypeWeb": "<p>Indicates whether users can access their WorkSpaces through a web browser.</p>", 64 "WorkspaceAccessProperties$DeviceTypeIos": "<p>Indicates whether users can use iOS devices to access their WorkSpaces.</p>", 65 "WorkspaceAccessProperties$DeviceTypeAndroid": "<p>Indicates whether users can use Android devices to access their WorkSpaces.</p>", 66 "WorkspaceAccessProperties$DeviceTypeChromeOs": "<p>Indicates whether users can use Chromebooks to access their WorkSpaces.</p>", 67 "WorkspaceAccessProperties$DeviceTypeZeroClient": "<p>Indicates whether users can use zero client devices to access their WorkSpaces.</p>" 68 } 69 }, 70 "AccountModification": { 71 "base": "<p>Describes a modification to the configuration of Bring Your Own License (BYOL) for the specified account. </p>", 72 "refs": { 73 "AccountModificationList$member": null 74 } 75 }, 76 "AccountModificationList": { 77 "base": null, 78 "refs": { 79 "DescribeAccountModificationsResult$AccountModifications": "<p>The list of modifications to the configuration of BYOL.</p>" 80 } 81 }, 82 "Alias": { 83 "base": null, 84 "refs": { 85 "WorkspaceDirectory$Alias": "<p>The directory alias.</p>" 86 } 87 }, 88 "AssociateIpGroupsRequest": { 89 "base": null, 90 "refs": { 91 } 92 }, 93 "AssociateIpGroupsResult": { 94 "base": null, 95 "refs": { 96 } 97 }, 98 "AuthorizeIpRulesRequest": { 99 "base": null, 100 "refs": { 101 } 102 }, 103 "AuthorizeIpRulesResult": { 104 "base": null, 105 "refs": { 106 } 107 }, 108 "BooleanObject": { 109 "base": null, 110 "refs": { 111 "DefaultWorkspaceCreationProperties$EnableWorkDocs": "<p>Specifies whether the directory is enabled for Amazon WorkDocs.</p>", 112 "DefaultWorkspaceCreationProperties$EnableInternetAccess": "<p>Specifies whether to automatically assign an Elastic public IP address to WorkSpaces in this directory by default. If enabled, the Elastic public IP address allows outbound internet access from your WorkSpaces when you’re using an internet gateway in the Amazon VPC in which your WorkSpaces are located. If you're using a Network Address Translation (NAT) gateway for outbound internet access from your VPC, or if your WorkSpaces are in public subnets and you manually assign them Elastic IP addresses, you should disable this setting. This setting applies to new WorkSpaces that you launch or to existing WorkSpaces that you rebuild. For more information, see <a href=\"https://docs.aws.amazon.com/workspaces/latest/adminguide/amazon-workspaces-vpc.html\"> Configure a VPC for Amazon WorkSpaces</a>.</p>", 113 "DefaultWorkspaceCreationProperties$UserEnabledAsLocalAdministrator": "<p>Specifies whether WorkSpace users are local administrators on their WorkSpaces.</p>", 114 "DefaultWorkspaceCreationProperties$EnableMaintenanceMode": "<p>Specifies whether maintenance mode is enabled for WorkSpaces. For more information, see <a href=\"https://docs.aws.amazon.com/workspaces/latest/adminguide/workspace-maintenance.html\">WorkSpace Maintenance</a>.</p>", 115 "RegisterWorkspaceDirectoryRequest$EnableWorkDocs": "<p>Indicates whether Amazon WorkDocs is enabled or disabled. If you have enabled this parameter and WorkDocs is not available in the Region, you will receive an OperationNotSupportedException error. Set <code>EnableWorkDocs</code> to disabled, and try again.</p>", 116 "RegisterWorkspaceDirectoryRequest$EnableSelfService": "<p>Indicates whether self-service capabilities are enabled or disabled.</p>", 117 "Workspace$UserVolumeEncryptionEnabled": "<p>Indicates whether the data stored on the user volume is encrypted.</p>", 118 "Workspace$RootVolumeEncryptionEnabled": "<p>Indicates whether the data stored on the root volume is encrypted.</p>", 119 "WorkspaceCreationProperties$EnableInternetAccess": "<p>Indicates whether internet access is enabled for your WorkSpaces.</p>", 120 "WorkspaceCreationProperties$UserEnabledAsLocalAdministrator": "<p>Indicates whether users are local administrators of their WorkSpaces.</p>", 121 "WorkspaceCreationProperties$EnableMaintenanceMode": "<p>Indicates whether maintenance mode is enabled for your WorkSpaces. For more information, see <a href=\"https://docs.aws.amazon.com/workspaces/latest/adminguide/workspace-maintenance.html\">WorkSpace Maintenance</a>. </p>", 122 "WorkspaceRequest$UserVolumeEncryptionEnabled": "<p>Indicates whether the data stored on the user volume is encrypted.</p>", 123 "WorkspaceRequest$RootVolumeEncryptionEnabled": "<p>Indicates whether the data stored on the root volume is encrypted.</p>" 124 } 125 }, 126 "BundleId": { 127 "base": null, 128 "refs": { 129 "BundleIdList$member": null, 130 "DescribeWorkspacesRequest$BundleId": "<p>The identifier of the bundle. All WorkSpaces that are created from this bundle are retrieved. You cannot combine this parameter with any other filter.</p>", 131 "Workspace$BundleId": "<p>The identifier of the bundle used to create the WorkSpace.</p>", 132 "WorkspaceBundle$BundleId": "<p>The bundle identifier.</p>", 133 "WorkspaceRequest$BundleId": "<p>The identifier of the bundle for the WorkSpace. You can use <a>DescribeWorkspaceBundles</a> to list the available bundles.</p>" 134 } 135 }, 136 "BundleIdList": { 137 "base": null, 138 "refs": { 139 "DescribeWorkspaceBundlesRequest$BundleIds": "<p>The identifiers of the bundles. You cannot combine this parameter with any other filter.</p>" 140 } 141 }, 142 "BundleList": { 143 "base": null, 144 "refs": { 145 "DescribeWorkspaceBundlesResult$Bundles": "<p>Information about the bundles.</p>" 146 } 147 }, 148 "BundleOwner": { 149 "base": null, 150 "refs": { 151 "DescribeWorkspaceBundlesRequest$Owner": "<p>The owner of the bundles. You cannot combine this parameter with any other filter.</p> <p>Specify <code>AMAZON</code> to describe the bundles provided by AWS or null to describe the bundles that belong to your account.</p>", 152 "WorkspaceBundle$Owner": "<p>The owner of the bundle. This is the account identifier of the owner, or <code>AMAZON</code> if the bundle is provided by AWS.</p>" 153 } 154 }, 155 "ClientProperties": { 156 "base": "<p>Describes an Amazon WorkSpaces client.</p>", 157 "refs": { 158 "ClientPropertiesResult$ClientProperties": "<p>Information about the Amazon WorkSpaces client.</p>", 159 "ModifyClientPropertiesRequest$ClientProperties": "<p>Information about the Amazon WorkSpaces client.</p>" 160 } 161 }, 162 "ClientPropertiesList": { 163 "base": null, 164 "refs": { 165 "DescribeClientPropertiesResult$ClientPropertiesList": "<p>Information about the specified Amazon WorkSpaces clients.</p>" 166 } 167 }, 168 "ClientPropertiesResult": { 169 "base": "<p>Information about the Amazon WorkSpaces client.</p>", 170 "refs": { 171 "ClientPropertiesList$member": null 172 } 173 }, 174 "Compute": { 175 "base": null, 176 "refs": { 177 "ComputeType$Name": "<p>The compute type.</p>", 178 "WorkspaceProperties$ComputeTypeName": "<p>The compute type. For more information, see <a href=\"http://aws.amazon.com/workspaces/details/#Amazon_WorkSpaces_Bundles\">Amazon WorkSpaces Bundles</a>.</p>" 179 } 180 }, 181 "ComputeType": { 182 "base": "<p>Describes the compute type.</p>", 183 "refs": { 184 "WorkspaceBundle$ComputeType": "<p>The compute type. For more information, see <a href=\"http://aws.amazon.com/workspaces/details/#Amazon_WorkSpaces_Bundles\">Amazon WorkSpaces Bundles</a>.</p>" 185 } 186 }, 187 "ComputerName": { 188 "base": null, 189 "refs": { 190 "Workspace$ComputerName": "<p>The name of the WorkSpace, as seen by the operating system.</p>" 191 } 192 }, 193 "ConnectionState": { 194 "base": null, 195 "refs": { 196 "WorkspaceConnectionStatus$ConnectionState": "<p>The connection state of the WorkSpace. The connection state is unknown if the WorkSpace is stopped.</p>" 197 } 198 }, 199 "CopyWorkspaceImageRequest": { 200 "base": null, 201 "refs": { 202 } 203 }, 204 "CopyWorkspaceImageResult": { 205 "base": null, 206 "refs": { 207 } 208 }, 209 "CreateIpGroupRequest": { 210 "base": null, 211 "refs": { 212 } 213 }, 214 "CreateIpGroupResult": { 215 "base": null, 216 "refs": { 217 } 218 }, 219 "CreateTagsRequest": { 220 "base": null, 221 "refs": { 222 } 223 }, 224 "CreateTagsResult": { 225 "base": null, 226 "refs": { 227 } 228 }, 229 "CreateWorkspacesRequest": { 230 "base": null, 231 "refs": { 232 } 233 }, 234 "CreateWorkspacesResult": { 235 "base": null, 236 "refs": { 237 } 238 }, 239 "DedicatedTenancyCidrRangeList": { 240 "base": null, 241 "refs": { 242 "ListAvailableManagementCidrRangesResult$ManagementCidrRanges": "<p>The list of available IP address ranges, specified as IPv4 CIDR blocks.</p>" 243 } 244 }, 245 "DedicatedTenancyManagementCidrRange": { 246 "base": null, 247 "refs": { 248 "AccountModification$DedicatedTenancyManagementCidrRange": "<p>The IP address range, specified as an IPv4 CIDR block, for the management network interface used for the account.</p>", 249 "DedicatedTenancyCidrRangeList$member": null, 250 "DescribeAccountResult$DedicatedTenancyManagementCidrRange": "<p>The IP address range, specified as an IPv4 CIDR block, used for the management network interface.</p> <p>The management network interface is connected to a secure Amazon WorkSpaces management network. It is used for interactive streaming of the WorkSpace desktop to Amazon WorkSpaces clients, and to allow Amazon WorkSpaces to manage the WorkSpace.</p>", 251 "ModifyAccountRequest$DedicatedTenancyManagementCidrRange": "<p>The IP address range, specified as an IPv4 CIDR block, for the management network interface. Specify an IP address range that is compatible with your network and in CIDR notation (that is, specify the range as an IPv4 CIDR block). The CIDR block size must be /16 (for example, 203.0.113.25/16). It must also be specified as available by the <code>ListAvailableManagementCidrRanges</code> operation.</p>" 252 } 253 }, 254 "DedicatedTenancyModificationStateEnum": { 255 "base": null, 256 "refs": { 257 "AccountModification$ModificationState": "<p>The state of the modification to the configuration of BYOL.</p>" 258 } 259 }, 260 "DedicatedTenancySupportEnum": { 261 "base": null, 262 "refs": { 263 "ModifyAccountRequest$DedicatedTenancySupport": "<p>The status of BYOL.</p>" 264 } 265 }, 266 "DedicatedTenancySupportResultEnum": { 267 "base": null, 268 "refs": { 269 "AccountModification$DedicatedTenancySupport": "<p>The status of BYOL (whether BYOL is being enabled or disabled).</p>", 270 "DescribeAccountResult$DedicatedTenancySupport": "<p>The status of BYOL (whether BYOL is enabled or disabled).</p>" 271 } 272 }, 273 "DefaultOu": { 274 "base": null, 275 "refs": { 276 "DefaultWorkspaceCreationProperties$DefaultOu": "<p>The organizational unit (OU) in the directory for the WorkSpace machine accounts.</p>", 277 "WorkspaceCreationProperties$DefaultOu": "<p>The default organizational unit (OU) for your WorkSpace directories.</p>" 278 } 279 }, 280 "DefaultWorkspaceCreationProperties": { 281 "base": "<p>Describes the default values that are used to create WorkSpaces. For more information, see <a href=\"https://docs.aws.amazon.com/workspaces/latest/adminguide/update-directory-details.html\">Update Directory Details for Your WorkSpaces</a>.</p>", 282 "refs": { 283 "WorkspaceDirectory$WorkspaceCreationProperties": "<p>The default creation properties for all WorkSpaces in the directory.</p>" 284 } 285 }, 286 "DeleteIpGroupRequest": { 287 "base": null, 288 "refs": { 289 } 290 }, 291 "DeleteIpGroupResult": { 292 "base": null, 293 "refs": { 294 } 295 }, 296 "DeleteTagsRequest": { 297 "base": null, 298 "refs": { 299 } 300 }, 301 "DeleteTagsResult": { 302 "base": null, 303 "refs": { 304 } 305 }, 306 "DeleteWorkspaceImageRequest": { 307 "base": null, 308 "refs": { 309 } 310 }, 311 "DeleteWorkspaceImageResult": { 312 "base": null, 313 "refs": { 314 } 315 }, 316 "DeregisterWorkspaceDirectoryRequest": { 317 "base": null, 318 "refs": { 319 } 320 }, 321 "DeregisterWorkspaceDirectoryResult": { 322 "base": null, 323 "refs": { 324 } 325 }, 326 "DescribeAccountModificationsRequest": { 327 "base": null, 328 "refs": { 329 } 330 }, 331 "DescribeAccountModificationsResult": { 332 "base": null, 333 "refs": { 334 } 335 }, 336 "DescribeAccountRequest": { 337 "base": null, 338 "refs": { 339 } 340 }, 341 "DescribeAccountResult": { 342 "base": null, 343 "refs": { 344 } 345 }, 346 "DescribeClientPropertiesRequest": { 347 "base": null, 348 "refs": { 349 } 350 }, 351 "DescribeClientPropertiesResult": { 352 "base": null, 353 "refs": { 354 } 355 }, 356 "DescribeIpGroupsRequest": { 357 "base": null, 358 "refs": { 359 } 360 }, 361 "DescribeIpGroupsResult": { 362 "base": null, 363 "refs": { 364 } 365 }, 366 "DescribeTagsRequest": { 367 "base": null, 368 "refs": { 369 } 370 }, 371 "DescribeTagsResult": { 372 "base": null, 373 "refs": { 374 } 375 }, 376 "DescribeWorkspaceBundlesRequest": { 377 "base": null, 378 "refs": { 379 } 380 }, 381 "DescribeWorkspaceBundlesResult": { 382 "base": null, 383 "refs": { 384 } 385 }, 386 "DescribeWorkspaceDirectoriesRequest": { 387 "base": null, 388 "refs": { 389 } 390 }, 391 "DescribeWorkspaceDirectoriesResult": { 392 "base": null, 393 "refs": { 394 } 395 }, 396 "DescribeWorkspaceImagesRequest": { 397 "base": null, 398 "refs": { 399 } 400 }, 401 "DescribeWorkspaceImagesResult": { 402 "base": null, 403 "refs": { 404 } 405 }, 406 "DescribeWorkspaceSnapshotsRequest": { 407 "base": null, 408 "refs": { 409 } 410 }, 411 "DescribeWorkspaceSnapshotsResult": { 412 "base": null, 413 "refs": { 414 } 415 }, 416 "DescribeWorkspacesConnectionStatusRequest": { 417 "base": null, 418 "refs": { 419 } 420 }, 421 "DescribeWorkspacesConnectionStatusResult": { 422 "base": null, 423 "refs": { 424 } 425 }, 426 "DescribeWorkspacesRequest": { 427 "base": null, 428 "refs": { 429 } 430 }, 431 "DescribeWorkspacesResult": { 432 "base": null, 433 "refs": { 434 } 435 }, 436 "Description": { 437 "base": null, 438 "refs": { 439 "AccountModification$ErrorMessage": "<p>The text of the error message that is returned if the configuration of BYOL cannot be modified.</p>", 440 "FailedCreateWorkspaceRequest$ErrorMessage": "<p>The text of the error message that is returned if the WorkSpace cannot be created.</p>", 441 "FailedWorkspaceChangeRequest$ErrorMessage": "<p>The text of the error message that is returned if the WorkSpace cannot be rebooted.</p>", 442 "Workspace$ErrorMessage": "<p>The text of the error message that is returned if the WorkSpace cannot be created.</p>", 443 "WorkspaceBundle$Description": "<p>A description.</p>", 444 "WorkspaceImage$ErrorMessage": "<p>The text of the error message that is returned for the image.</p>" 445 } 446 }, 447 "DirectoryId": { 448 "base": null, 449 "refs": { 450 "AssociateIpGroupsRequest$DirectoryId": "<p>The identifier of the directory.</p>", 451 "DeregisterWorkspaceDirectoryRequest$DirectoryId": "<p>The identifier of the directory. If any WorkSpaces are registered to this directory, you must remove them before you deregister the directory, or you will receive an OperationNotSupportedException error.</p>", 452 "DescribeWorkspacesRequest$DirectoryId": "<p>The identifier of the directory. In addition, you can optionally specify a specific directory user (see <code>UserName</code>). You cannot combine this parameter with any other filter.</p>", 453 "DirectoryIdList$member": null, 454 "DisassociateIpGroupsRequest$DirectoryId": "<p>The identifier of the directory.</p>", 455 "ModifySelfservicePermissionsRequest$ResourceId": "<p>The identifier of the directory.</p>", 456 "ModifyWorkspaceAccessPropertiesRequest$ResourceId": "<p>The identifier of the directory.</p>", 457 "ModifyWorkspaceCreationPropertiesRequest$ResourceId": "<p>The identifier of the directory.</p>", 458 "RegisterWorkspaceDirectoryRequest$DirectoryId": "<p>The identifier of the directory. You cannot register a directory if it does not have a status of Active. If the directory does not have a status of Active, you will receive an InvalidResourceStateException error. If you have already registered the maximum number of directories that you can register with Amazon WorkSpaces, you will receive a ResourceLimitExceededException error. Deregister directories that you are not using for WorkSpaces, and try again.</p>", 459 "Workspace$DirectoryId": "<p>The identifier of the AWS Directory Service directory for the WorkSpace.</p>", 460 "WorkspaceDirectory$DirectoryId": "<p>The directory identifier.</p>", 461 "WorkspaceRequest$DirectoryId": "<p>The identifier of the AWS Directory Service directory for the WorkSpace. You can use <a>DescribeWorkspaceDirectories</a> to list the available directories.</p>" 462 } 463 }, 464 "DirectoryIdList": { 465 "base": null, 466 "refs": { 467 "DescribeWorkspaceDirectoriesRequest$DirectoryIds": "<p>The identifiers of the directories. If the value is null, all directories are retrieved.</p>" 468 } 469 }, 470 "DirectoryList": { 471 "base": null, 472 "refs": { 473 "DescribeWorkspaceDirectoriesResult$Directories": "<p>Information about the directories.</p>" 474 } 475 }, 476 "DirectoryName": { 477 "base": null, 478 "refs": { 479 "WorkspaceDirectory$DirectoryName": "<p>The name of the directory.</p>" 480 } 481 }, 482 "DisassociateIpGroupsRequest": { 483 "base": null, 484 "refs": { 485 } 486 }, 487 "DisassociateIpGroupsResult": { 488 "base": null, 489 "refs": { 490 } 491 }, 492 "DnsIpAddresses": { 493 "base": null, 494 "refs": { 495 "WorkspaceDirectory$DnsIpAddresses": "<p>The IP addresses of the DNS servers for the directory.</p>" 496 } 497 }, 498 "Ec2ImageId": { 499 "base": null, 500 "refs": { 501 "ImportWorkspaceImageRequest$Ec2ImageId": "<p>The identifier of the EC2 image.</p>" 502 } 503 }, 504 "ErrorType": { 505 "base": null, 506 "refs": { 507 "FailedCreateWorkspaceRequest$ErrorCode": "<p>The error code that is returned if the WorkSpace cannot be created.</p>", 508 "FailedWorkspaceChangeRequest$ErrorCode": "<p>The error code that is returned if the WorkSpace cannot be rebooted.</p>" 509 } 510 }, 511 "ExceptionMessage": { 512 "base": null, 513 "refs": { 514 "AccessDeniedException$message": null, 515 "InvalidParameterValuesException$message": "<p>The exception error message.</p>", 516 "InvalidResourceStateException$message": null, 517 "OperationInProgressException$message": null, 518 "OperationNotSupportedException$message": null, 519 "ResourceAlreadyExistsException$message": null, 520 "ResourceAssociatedException$message": null, 521 "ResourceCreationFailedException$message": null, 522 "ResourceLimitExceededException$message": "<p>The exception error message.</p>", 523 "ResourceNotFoundException$message": "<p>The resource could not be found.</p>", 524 "ResourceUnavailableException$message": "<p>The exception error message.</p>", 525 "UnsupportedNetworkConfigurationException$message": null, 526 "UnsupportedWorkspaceConfigurationException$message": null, 527 "WorkspacesDefaultRoleNotFoundException$message": null 528 } 529 }, 530 "FailedCreateWorkspaceRequest": { 531 "base": "<p>Describes a WorkSpace that cannot be created.</p>", 532 "refs": { 533 "FailedCreateWorkspaceRequests$member": null 534 } 535 }, 536 "FailedCreateWorkspaceRequests": { 537 "base": null, 538 "refs": { 539 "CreateWorkspacesResult$FailedRequests": "<p>Information about the WorkSpaces that could not be created.</p>" 540 } 541 }, 542 "FailedRebootWorkspaceRequests": { 543 "base": null, 544 "refs": { 545 "RebootWorkspacesResult$FailedRequests": "<p>Information about the WorkSpaces that could not be rebooted.</p>" 546 } 547 }, 548 "FailedRebuildWorkspaceRequests": { 549 "base": null, 550 "refs": { 551 "RebuildWorkspacesResult$FailedRequests": "<p>Information about the WorkSpace that could not be rebuilt.</p>" 552 } 553 }, 554 "FailedStartWorkspaceRequests": { 555 "base": null, 556 "refs": { 557 "StartWorkspacesResult$FailedRequests": "<p>Information about the WorkSpaces that could not be started.</p>" 558 } 559 }, 560 "FailedStopWorkspaceRequests": { 561 "base": null, 562 "refs": { 563 "StopWorkspacesResult$FailedRequests": "<p>Information about the WorkSpaces that could not be stopped.</p>" 564 } 565 }, 566 "FailedTerminateWorkspaceRequests": { 567 "base": null, 568 "refs": { 569 "TerminateWorkspacesResult$FailedRequests": "<p>Information about the WorkSpaces that could not be terminated.</p>" 570 } 571 }, 572 "FailedWorkspaceChangeRequest": { 573 "base": "<p>Describes a WorkSpace that could not be rebooted. (<a>RebootWorkspaces</a>), rebuilt (<a>RebuildWorkspaces</a>), restored (<a>RestoreWorkspace</a>), terminated (<a>TerminateWorkspaces</a>), started (<a>StartWorkspaces</a>), or stopped (<a>StopWorkspaces</a>).</p>", 574 "refs": { 575 "FailedRebootWorkspaceRequests$member": null, 576 "FailedRebuildWorkspaceRequests$member": null, 577 "FailedStartWorkspaceRequests$member": null, 578 "FailedStopWorkspaceRequests$member": null, 579 "FailedTerminateWorkspaceRequests$member": null 580 } 581 }, 582 "ImportWorkspaceImageRequest": { 583 "base": null, 584 "refs": { 585 } 586 }, 587 "ImportWorkspaceImageResult": { 588 "base": null, 589 "refs": { 590 } 591 }, 592 "InvalidParameterValuesException": { 593 "base": "<p>One or more parameter values are not valid.</p>", 594 "refs": { 595 } 596 }, 597 "InvalidResourceStateException": { 598 "base": "<p>The state of the resource is not valid for this operation.</p>", 599 "refs": { 600 } 601 }, 602 "IpAddress": { 603 "base": null, 604 "refs": { 605 "DnsIpAddresses$member": null, 606 "Workspace$IpAddress": "<p>The IP address of the WorkSpace.</p>" 607 } 608 }, 609 "IpGroupDesc": { 610 "base": null, 611 "refs": { 612 "CreateIpGroupRequest$GroupDesc": "<p>The description of the group.</p>", 613 "WorkspacesIpGroup$groupDesc": "<p>The description of the group.</p>" 614 } 615 }, 616 "IpGroupId": { 617 "base": null, 618 "refs": { 619 "AuthorizeIpRulesRequest$GroupId": "<p>The identifier of the group.</p>", 620 "CreateIpGroupResult$GroupId": "<p>The identifier of the group.</p>", 621 "DeleteIpGroupRequest$GroupId": "<p>The identifier of the IP access control group.</p>", 622 "IpGroupIdList$member": null, 623 "RevokeIpRulesRequest$GroupId": "<p>The identifier of the group.</p>", 624 "UpdateRulesOfIpGroupRequest$GroupId": "<p>The identifier of the group.</p>", 625 "WorkspacesIpGroup$groupId": "<p>The identifier of the group.</p>" 626 } 627 }, 628 "IpGroupIdList": { 629 "base": null, 630 "refs": { 631 "AssociateIpGroupsRequest$GroupIds": "<p>The identifiers of one or more IP access control groups.</p>", 632 "DescribeIpGroupsRequest$GroupIds": "<p>The identifiers of one or more IP access control groups.</p>", 633 "DisassociateIpGroupsRequest$GroupIds": "<p>The identifiers of one or more IP access control groups.</p>", 634 "WorkspaceDirectory$ipGroupIds": "<p>The identifiers of the IP access control groups associated with the directory.</p>" 635 } 636 }, 637 "IpGroupName": { 638 "base": null, 639 "refs": { 640 "CreateIpGroupRequest$GroupName": "<p>The name of the group.</p>", 641 "WorkspacesIpGroup$groupName": "<p>The name of the group.</p>" 642 } 643 }, 644 "IpRevokedRuleList": { 645 "base": null, 646 "refs": { 647 "RevokeIpRulesRequest$UserRules": "<p>The rules to remove from the group.</p>" 648 } 649 }, 650 "IpRule": { 651 "base": null, 652 "refs": { 653 "IpRevokedRuleList$member": null, 654 "IpRuleItem$ipRule": "<p>The IP address range, in CIDR notation.</p>" 655 } 656 }, 657 "IpRuleDesc": { 658 "base": null, 659 "refs": { 660 "IpRuleItem$ruleDesc": "<p>The description.</p>" 661 } 662 }, 663 "IpRuleItem": { 664 "base": "<p>Describes a rule for an IP access control group.</p>", 665 "refs": { 666 "IpRuleList$member": null 667 } 668 }, 669 "IpRuleList": { 670 "base": null, 671 "refs": { 672 "AuthorizeIpRulesRequest$UserRules": "<p>The rules to add to the group.</p>", 673 "CreateIpGroupRequest$UserRules": "<p>The rules to add to the group.</p>", 674 "UpdateRulesOfIpGroupRequest$UserRules": "<p>One or more rules.</p>", 675 "WorkspacesIpGroup$userRules": "<p>The rules.</p>" 676 } 677 }, 678 "Limit": { 679 "base": null, 680 "refs": { 681 "DescribeIpGroupsRequest$MaxResults": "<p>The maximum number of items to return.</p>", 682 "DescribeWorkspaceDirectoriesRequest$Limit": "<p>The maximum number of directories to return.</p>", 683 "DescribeWorkspaceImagesRequest$MaxResults": "<p>The maximum number of items to return.</p>", 684 "DescribeWorkspacesRequest$Limit": "<p>The maximum number of items to return.</p>" 685 } 686 }, 687 "ListAvailableManagementCidrRangesRequest": { 688 "base": null, 689 "refs": { 690 } 691 }, 692 "ListAvailableManagementCidrRangesResult": { 693 "base": null, 694 "refs": { 695 } 696 }, 697 "ManagementCidrRangeConstraint": { 698 "base": null, 699 "refs": { 700 "ListAvailableManagementCidrRangesRequest$ManagementCidrRangeConstraint": "<p>The IP address range to search. Specify an IP address range that is compatible with your network and in CIDR notation (that is, specify the range as an IPv4 CIDR block).</p>" 701 } 702 }, 703 "ManagementCidrRangeMaxResults": { 704 "base": null, 705 "refs": { 706 "ListAvailableManagementCidrRangesRequest$MaxResults": "<p>The maximum number of items to return.</p>" 707 } 708 }, 709 "ModificationResourceEnum": { 710 "base": null, 711 "refs": { 712 "ModificationState$Resource": "<p>The resource.</p>" 713 } 714 }, 715 "ModificationState": { 716 "base": "<p>Describes a WorkSpace modification.</p>", 717 "refs": { 718 "ModificationStateList$member": null 719 } 720 }, 721 "ModificationStateEnum": { 722 "base": null, 723 "refs": { 724 "ModificationState$State": "<p>The modification state.</p>" 725 } 726 }, 727 "ModificationStateList": { 728 "base": null, 729 "refs": { 730 "Workspace$ModificationStates": "<p>The modification states of the WorkSpace.</p>" 731 } 732 }, 733 "ModifyAccountRequest": { 734 "base": null, 735 "refs": { 736 } 737 }, 738 "ModifyAccountResult": { 739 "base": null, 740 "refs": { 741 } 742 }, 743 "ModifyClientPropertiesRequest": { 744 "base": null, 745 "refs": { 746 } 747 }, 748 "ModifyClientPropertiesResult": { 749 "base": null, 750 "refs": { 751 } 752 }, 753 "ModifySelfservicePermissionsRequest": { 754 "base": null, 755 "refs": { 756 } 757 }, 758 "ModifySelfservicePermissionsResult": { 759 "base": null, 760 "refs": { 761 } 762 }, 763 "ModifyWorkspaceAccessPropertiesRequest": { 764 "base": null, 765 "refs": { 766 } 767 }, 768 "ModifyWorkspaceAccessPropertiesResult": { 769 "base": null, 770 "refs": { 771 } 772 }, 773 "ModifyWorkspaceCreationPropertiesRequest": { 774 "base": null, 775 "refs": { 776 } 777 }, 778 "ModifyWorkspaceCreationPropertiesResult": { 779 "base": null, 780 "refs": { 781 } 782 }, 783 "ModifyWorkspacePropertiesRequest": { 784 "base": null, 785 "refs": { 786 } 787 }, 788 "ModifyWorkspacePropertiesResult": { 789 "base": null, 790 "refs": { 791 } 792 }, 793 "ModifyWorkspaceStateRequest": { 794 "base": null, 795 "refs": { 796 } 797 }, 798 "ModifyWorkspaceStateResult": { 799 "base": null, 800 "refs": { 801 } 802 }, 803 "NonEmptyString": { 804 "base": null, 805 "refs": { 806 "ClientPropertiesResult$ResourceId": "<p>The resource identifier, in the form of a directory ID.</p>", 807 "CreateTagsRequest$ResourceId": "<p>The identifier of the WorkSpaces resource. The supported resource types are WorkSpaces, registered directories, images, custom bundles, and IP access control groups.</p>", 808 "DeleteTagsRequest$ResourceId": "<p>The identifier of the WorkSpaces resource. The supported resource types are WorkSpaces, registered directories, images, custom bundles, and IP access control groups.</p>", 809 "DescribeTagsRequest$ResourceId": "<p>The identifier of the WorkSpaces resource. The supported resource types are WorkSpaces, registered directories, images, custom bundles, and IP access control groups.</p>", 810 "ModifyClientPropertiesRequest$ResourceId": "<p>The resource identifiers, in the form of directory IDs.</p>", 811 "ResourceIdList$member": null, 812 "ResourceNotFoundException$ResourceId": "<p>The ID of the resource that could not be found.</p>", 813 "ResourceUnavailableException$ResourceId": "<p>The identifier of the resource that is not available.</p>", 814 "RootStorage$Capacity": "<p>The size of the root volume.</p>", 815 "TagKeyList$member": null, 816 "UserStorage$Capacity": "<p>The size of the user storage.</p>", 817 "WorkspaceBundle$Name": "<p>The name of the bundle.</p>" 818 } 819 }, 820 "OperatingSystem": { 821 "base": "<p>The operating system that the image is running.</p>", 822 "refs": { 823 "WorkspaceImage$OperatingSystem": "<p>The operating system that the image is running. </p>" 824 } 825 }, 826 "OperatingSystemType": { 827 "base": null, 828 "refs": { 829 "OperatingSystem$Type": "<p>The operating system.</p>" 830 } 831 }, 832 "OperationInProgressException": { 833 "base": "<p>The properties of this WorkSpace are currently being modified. Try again in a moment.</p>", 834 "refs": { 835 } 836 }, 837 "OperationNotSupportedException": { 838 "base": "<p>This operation is not supported.</p>", 839 "refs": { 840 } 841 }, 842 "PaginationToken": { 843 "base": null, 844 "refs": { 845 "DescribeAccountModificationsRequest$NextToken": "<p>If you received a <code>NextToken</code> from a previous call that was paginated, provide this token to receive the next set of results.</p>", 846 "DescribeAccountModificationsResult$NextToken": "<p>The token to use to retrieve the next set of results, or null if no more results are available.</p>", 847 "DescribeIpGroupsRequest$NextToken": "<p>If you received a <code>NextToken</code> from a previous call that was paginated, provide this token to receive the next set of results.</p>", 848 "DescribeIpGroupsResult$NextToken": "<p>The token to use to retrieve the next set of results, or null if no more results are available.</p>", 849 "DescribeWorkspaceBundlesRequest$NextToken": "<p>The token for the next set of results. (You received this token from a previous call.)</p>", 850 "DescribeWorkspaceBundlesResult$NextToken": "<p>The token to use to retrieve the next set of results, or null if there are no more results available. This token is valid for one day and must be used within that time frame.</p>", 851 "DescribeWorkspaceDirectoriesRequest$NextToken": "<p>If you received a <code>NextToken</code> from a previous call that was paginated, provide this token to receive the next set of results.</p>", 852 "DescribeWorkspaceDirectoriesResult$NextToken": "<p>The token to use to retrieve the next set of results, or null if no more results are available.</p>", 853 "DescribeWorkspaceImagesRequest$NextToken": "<p>If you received a <code>NextToken</code> from a previous call that was paginated, provide this token to receive the next set of results.</p>", 854 "DescribeWorkspaceImagesResult$NextToken": "<p>The token to use to retrieve the next set of results, or null if no more results are available.</p>", 855 "DescribeWorkspacesConnectionStatusRequest$NextToken": "<p>If you received a <code>NextToken</code> from a previous call that was paginated, provide this token to receive the next set of results.</p>", 856 "DescribeWorkspacesConnectionStatusResult$NextToken": "<p>The token to use to retrieve the next set of results, or null if no more results are available.</p>", 857 "DescribeWorkspacesRequest$NextToken": "<p>If you received a <code>NextToken</code> from a previous call that was paginated, provide this token to receive the next set of results.</p>", 858 "DescribeWorkspacesResult$NextToken": "<p>The token to use to retrieve the next set of results, or null if no more results are available.</p>", 859 "ListAvailableManagementCidrRangesRequest$NextToken": "<p>If you received a <code>NextToken</code> from a previous call that was paginated, provide this token to receive the next set of results.</p>", 860 "ListAvailableManagementCidrRangesResult$NextToken": "<p>The token to use to retrieve the next set of results, or null if no more results are available.</p>" 861 } 862 }, 863 "RebootRequest": { 864 "base": "<p>Describes the information used to reboot a WorkSpace.</p>", 865 "refs": { 866 "RebootWorkspaceRequests$member": null 867 } 868 }, 869 "RebootWorkspaceRequests": { 870 "base": null, 871 "refs": { 872 "RebootWorkspacesRequest$RebootWorkspaceRequests": "<p>The WorkSpaces to reboot. You can specify up to 25 WorkSpaces.</p>" 873 } 874 }, 875 "RebootWorkspacesRequest": { 876 "base": null, 877 "refs": { 878 } 879 }, 880 "RebootWorkspacesResult": { 881 "base": null, 882 "refs": { 883 } 884 }, 885 "RebuildRequest": { 886 "base": "<p>Describes the information used to rebuild a WorkSpace.</p>", 887 "refs": { 888 "RebuildWorkspaceRequests$member": null 889 } 890 }, 891 "RebuildWorkspaceRequests": { 892 "base": null, 893 "refs": { 894 "RebuildWorkspacesRequest$RebuildWorkspaceRequests": "<p>The WorkSpace to rebuild. You can specify a single WorkSpace.</p>" 895 } 896 }, 897 "RebuildWorkspacesRequest": { 898 "base": null, 899 "refs": { 900 } 901 }, 902 "RebuildWorkspacesResult": { 903 "base": null, 904 "refs": { 905 } 906 }, 907 "ReconnectEnum": { 908 "base": null, 909 "refs": { 910 "ClientProperties$ReconnectEnabled": "<p>Specifies whether users can cache their credentials on the Amazon WorkSpaces client. When enabled, users can choose to reconnect to their WorkSpaces without re-entering their credentials. </p>", 911 "SelfservicePermissions$RestartWorkspace": "<p>Specifies whether users can restart their WorkSpace.</p>", 912 "SelfservicePermissions$IncreaseVolumeSize": "<p>Specifies whether users can increase the volume size of the drives on their WorkSpace.</p>", 913 "SelfservicePermissions$ChangeComputeType": "<p>Specifies whether users can change the compute type (bundle) for their WorkSpace.</p>", 914 "SelfservicePermissions$SwitchRunningMode": "<p>Specifies whether users can switch the running mode of their WorkSpace.</p>", 915 "SelfservicePermissions$RebuildWorkspace": "<p>Specifies whether users can rebuild the operating system of a WorkSpace to its original state.</p>" 916 } 917 }, 918 "Region": { 919 "base": null, 920 "refs": { 921 "CopyWorkspaceImageRequest$SourceRegion": "<p>The identifier of the source Region.</p>" 922 } 923 }, 924 "RegisterWorkspaceDirectoryRequest": { 925 "base": null, 926 "refs": { 927 } 928 }, 929 "RegisterWorkspaceDirectoryResult": { 930 "base": null, 931 "refs": { 932 } 933 }, 934 "RegistrationCode": { 935 "base": null, 936 "refs": { 937 "WorkspaceDirectory$RegistrationCode": "<p>The registration code for the directory. This is the code that users enter in their Amazon WorkSpaces client application to connect to the directory.</p>" 938 } 939 }, 940 "ResourceAlreadyExistsException": { 941 "base": "<p>The specified resource already exists.</p>", 942 "refs": { 943 } 944 }, 945 "ResourceAssociatedException": { 946 "base": "<p>The resource is associated with a directory.</p>", 947 "refs": { 948 } 949 }, 950 "ResourceCreationFailedException": { 951 "base": "<p>The resource could not be created.</p>", 952 "refs": { 953 } 954 }, 955 "ResourceIdList": { 956 "base": null, 957 "refs": { 958 "DescribeClientPropertiesRequest$ResourceIds": "<p>The resource identifier, in the form of directory IDs.</p>" 959 } 960 }, 961 "ResourceLimitExceededException": { 962 "base": "<p>Your resource limits have been exceeded.</p>", 963 "refs": { 964 } 965 }, 966 "ResourceNotFoundException": { 967 "base": "<p>The resource could not be found.</p>", 968 "refs": { 969 } 970 }, 971 "ResourceUnavailableException": { 972 "base": "<p>The specified resource is not available.</p>", 973 "refs": { 974 } 975 }, 976 "RestoreWorkspaceRequest": { 977 "base": null, 978 "refs": { 979 } 980 }, 981 "RestoreWorkspaceResult": { 982 "base": null, 983 "refs": { 984 } 985 }, 986 "RevokeIpRulesRequest": { 987 "base": null, 988 "refs": { 989 } 990 }, 991 "RevokeIpRulesResult": { 992 "base": null, 993 "refs": { 994 } 995 }, 996 "RootStorage": { 997 "base": "<p>Describes the root volume for a WorkSpace bundle.</p>", 998 "refs": { 999 "WorkspaceBundle$RootStorage": "<p>The size of the root volume.</p>" 1000 } 1001 }, 1002 "RootVolumeSizeGib": { 1003 "base": null, 1004 "refs": { 1005 "WorkspaceProperties$RootVolumeSizeGib": "<p>The size of the root volume.</p>" 1006 } 1007 }, 1008 "RunningMode": { 1009 "base": null, 1010 "refs": { 1011 "WorkspaceProperties$RunningMode": "<p>The running mode. For more information, see <a href=\"https://docs.aws.amazon.com/workspaces/latest/adminguide/running-mode.html\">Manage the WorkSpace Running Mode</a>.</p>" 1012 } 1013 }, 1014 "RunningModeAutoStopTimeoutInMinutes": { 1015 "base": null, 1016 "refs": { 1017 "WorkspaceProperties$RunningModeAutoStopTimeoutInMinutes": "<p>The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60-minute intervals.</p>" 1018 } 1019 }, 1020 "SecurityGroupId": { 1021 "base": null, 1022 "refs": { 1023 "DefaultWorkspaceCreationProperties$CustomSecurityGroupId": "<p>The identifier of any security groups to apply to WorkSpaces when they are created.</p>", 1024 "WorkspaceCreationProperties$CustomSecurityGroupId": "<p>The identifier of your custom security group.</p>", 1025 "WorkspaceDirectory$WorkspaceSecurityGroupId": "<p>The identifier of the security group that is assigned to new WorkSpaces.</p>" 1026 } 1027 }, 1028 "SelfservicePermissions": { 1029 "base": "<p>Describes the self-service permissions for a directory. For more information, see <a href=\"https://docs.aws.amazon.com/workspaces/latest/adminguide/enable-user-self-service-workspace-management.html\">Enable Self-Service WorkSpace Management Capabilities for Your Users</a>.</p>", 1030 "refs": { 1031 "ModifySelfservicePermissionsRequest$SelfservicePermissions": "<p>The permissions to enable or disable self-service capabilities.</p>", 1032 "WorkspaceDirectory$SelfservicePermissions": "<p>The default self-service permissions for WorkSpaces in the directory.</p>" 1033 } 1034 }, 1035 "Snapshot": { 1036 "base": "<p>Describes a snapshot.</p>", 1037 "refs": { 1038 "SnapshotList$member": null 1039 } 1040 }, 1041 "SnapshotList": { 1042 "base": null, 1043 "refs": { 1044 "DescribeWorkspaceSnapshotsResult$RebuildSnapshots": "<p>Information about the snapshots that can be used to rebuild a WorkSpace. These snapshots include the user volume.</p>", 1045 "DescribeWorkspaceSnapshotsResult$RestoreSnapshots": "<p>Information about the snapshots that can be used to restore a WorkSpace. These snapshots include both the root volume and the user volume.</p>" 1046 } 1047 }, 1048 "StartRequest": { 1049 "base": "<p>Information used to start a WorkSpace.</p>", 1050 "refs": { 1051 "StartWorkspaceRequests$member": null 1052 } 1053 }, 1054 "StartWorkspaceRequests": { 1055 "base": null, 1056 "refs": { 1057 "StartWorkspacesRequest$StartWorkspaceRequests": "<p>The WorkSpaces to start. You can specify up to 25 WorkSpaces.</p>" 1058 } 1059 }, 1060 "StartWorkspacesRequest": { 1061 "base": null, 1062 "refs": { 1063 } 1064 }, 1065 "StartWorkspacesResult": { 1066 "base": null, 1067 "refs": { 1068 } 1069 }, 1070 "StopRequest": { 1071 "base": "<p>Describes the information used to stop a WorkSpace.</p>", 1072 "refs": { 1073 "StopWorkspaceRequests$member": null 1074 } 1075 }, 1076 "StopWorkspaceRequests": { 1077 "base": null, 1078 "refs": { 1079 "StopWorkspacesRequest$StopWorkspaceRequests": "<p>The WorkSpaces to stop. You can specify up to 25 WorkSpaces.</p>" 1080 } 1081 }, 1082 "StopWorkspacesRequest": { 1083 "base": null, 1084 "refs": { 1085 } 1086 }, 1087 "StopWorkspacesResult": { 1088 "base": null, 1089 "refs": { 1090 } 1091 }, 1092 "SubnetId": { 1093 "base": null, 1094 "refs": { 1095 "SubnetIds$member": null, 1096 "Workspace$SubnetId": "<p>The identifier of the subnet for the WorkSpace.</p>" 1097 } 1098 }, 1099 "SubnetIds": { 1100 "base": null, 1101 "refs": { 1102 "RegisterWorkspaceDirectoryRequest$SubnetIds": "<p>The identifiers of the subnets for your virtual private cloud (VPC). Make sure that the subnets are in supported Availability Zones. The subnets must also be in separate Availability Zones. If these conditions are not met, you will receive an OperationNotSupportedException error.</p>", 1103 "WorkspaceDirectory$SubnetIds": "<p>The identifiers of the subnets used with the directory.</p>" 1104 } 1105 }, 1106 "Tag": { 1107 "base": "<p>Describes a tag.</p>", 1108 "refs": { 1109 "TagList$member": null 1110 } 1111 }, 1112 "TagKey": { 1113 "base": null, 1114 "refs": { 1115 "Tag$Key": "<p>The key of the tag.</p>" 1116 } 1117 }, 1118 "TagKeyList": { 1119 "base": null, 1120 "refs": { 1121 "DeleteTagsRequest$TagKeys": "<p>The tag keys.</p>" 1122 } 1123 }, 1124 "TagList": { 1125 "base": null, 1126 "refs": { 1127 "CopyWorkspaceImageRequest$Tags": "<p>The tags for the image.</p>", 1128 "CreateIpGroupRequest$Tags": "<p>The tags. Each WorkSpaces resource can have a maximum of 50 tags.</p>", 1129 "CreateTagsRequest$Tags": "<p>The tags. Each WorkSpaces resource can have a maximum of 50 tags.</p>", 1130 "DescribeTagsResult$TagList": "<p>The tags.</p>", 1131 "ImportWorkspaceImageRequest$Tags": "<p>The tags. Each WorkSpaces resource can have a maximum of 50 tags.</p>", 1132 "RegisterWorkspaceDirectoryRequest$Tags": "<p>The tags associated with the directory.</p>", 1133 "WorkspaceRequest$Tags": "<p>The tags for the WorkSpace.</p>" 1134 } 1135 }, 1136 "TagValue": { 1137 "base": null, 1138 "refs": { 1139 "Tag$Value": "<p>The value of the tag.</p>" 1140 } 1141 }, 1142 "TargetWorkspaceState": { 1143 "base": null, 1144 "refs": { 1145 "ModifyWorkspaceStateRequest$WorkspaceState": "<p>The WorkSpace state.</p>" 1146 } 1147 }, 1148 "Tenancy": { 1149 "base": null, 1150 "refs": { 1151 "RegisterWorkspaceDirectoryRequest$Tenancy": "<p>Indicates whether your WorkSpace directory is dedicated or shared. To use Bring Your Own License (BYOL) images, this value must be set to <code>DEDICATED</code> and your AWS account must be enabled for BYOL. If your account has not been enabled for BYOL, you will receive an InvalidParameterValuesException error. For more information about BYOL images, see <a href=\"https://docs.aws.amazon.com/workspaces/latest/adminguide/byol-windows-images.html\">Bring Your Own Windows Desktop Images</a>.</p>", 1152 "WorkspaceDirectory$Tenancy": "<p>Specifies whether the directory is dedicated or shared. To use Bring Your Own License (BYOL), this value must be set to <code>DEDICATED</code>. For more information, see <a href=\"https://docs.aws.amazon.com/workspaces/latest/adminguide/byol-windows-images.html\">Bring Your Own Windows Desktop Images</a>.</p>" 1153 } 1154 }, 1155 "TerminateRequest": { 1156 "base": "<p>Describes the information used to terminate a WorkSpace.</p>", 1157 "refs": { 1158 "TerminateWorkspaceRequests$member": null 1159 } 1160 }, 1161 "TerminateWorkspaceRequests": { 1162 "base": null, 1163 "refs": { 1164 "TerminateWorkspacesRequest$TerminateWorkspaceRequests": "<p>The WorkSpaces to terminate. You can specify up to 25 WorkSpaces.</p>" 1165 } 1166 }, 1167 "TerminateWorkspacesRequest": { 1168 "base": null, 1169 "refs": { 1170 } 1171 }, 1172 "TerminateWorkspacesResult": { 1173 "base": null, 1174 "refs": { 1175 } 1176 }, 1177 "Timestamp": { 1178 "base": null, 1179 "refs": { 1180 "AccountModification$StartTime": "<p>The timestamp when the modification of the BYOL configuration was started.</p>", 1181 "Snapshot$SnapshotTime": "<p>The time when the snapshot was created.</p>", 1182 "WorkspaceBundle$LastUpdatedTime": "<p>The last time that the bundle was updated.</p>", 1183 "WorkspaceConnectionStatus$ConnectionStateCheckTimestamp": "<p>The timestamp of the connection status check.</p>", 1184 "WorkspaceConnectionStatus$LastKnownUserConnectionTimestamp": "<p>The timestamp of the last known user connection.</p>" 1185 } 1186 }, 1187 "UnsupportedNetworkConfigurationException": { 1188 "base": "<p>The configuration of this network is not supported for this operation, or your network configuration conflicts with the Amazon WorkSpaces management network IP range. For more information, see <a href=\"https://docs.aws.amazon.com/workspaces/latest/adminguide/amazon-workspaces-vpc.html\"> Configure a VPC for Amazon WorkSpaces</a>.</p>", 1189 "refs": { 1190 } 1191 }, 1192 "UnsupportedWorkspaceConfigurationException": { 1193 "base": "<p>The configuration of this WorkSpace is not supported for this operation. For more information, see <a href=\"https://docs.aws.amazon.com/workspaces/latest/adminguide/required-service-components.html\">Required Configuration and Service Components for WorkSpaces </a>.</p>", 1194 "refs": { 1195 } 1196 }, 1197 "UpdateRulesOfIpGroupRequest": { 1198 "base": null, 1199 "refs": { 1200 } 1201 }, 1202 "UpdateRulesOfIpGroupResult": { 1203 "base": null, 1204 "refs": { 1205 } 1206 }, 1207 "UserName": { 1208 "base": null, 1209 "refs": { 1210 "DescribeWorkspacesRequest$UserName": "<p>The name of the directory user. You must specify this parameter with <code>DirectoryId</code>.</p>", 1211 "Workspace$UserName": "<p>The user for the WorkSpace.</p>", 1212 "WorkspaceDirectory$CustomerUserName": "<p>The user name for the service account.</p>", 1213 "WorkspaceRequest$UserName": "<p>The user name of the user for the WorkSpace. This user name must exist in the AWS Directory Service directory for the WorkSpace.</p>" 1214 } 1215 }, 1216 "UserStorage": { 1217 "base": "<p>Describes the user storage for a WorkSpace bundle.</p>", 1218 "refs": { 1219 "WorkspaceBundle$UserStorage": "<p>The size of the user storage.</p>" 1220 } 1221 }, 1222 "UserVolumeSizeGib": { 1223 "base": null, 1224 "refs": { 1225 "WorkspaceProperties$UserVolumeSizeGib": "<p>The size of the user storage.</p>" 1226 } 1227 }, 1228 "VolumeEncryptionKey": { 1229 "base": null, 1230 "refs": { 1231 "Workspace$VolumeEncryptionKey": "<p>The KMS key used to encrypt data stored on your WorkSpace.</p>", 1232 "WorkspaceRequest$VolumeEncryptionKey": "<p>The KMS key used to encrypt data stored on your WorkSpace.</p>" 1233 } 1234 }, 1235 "Workspace": { 1236 "base": "<p>Describes a WorkSpace.</p>", 1237 "refs": { 1238 "WorkspaceList$member": null 1239 } 1240 }, 1241 "WorkspaceAccessProperties": { 1242 "base": "<p>The device types and operating systems that can be used to access a WorkSpace. For more information, see <a href=\"https://docs.aws.amazon.com/workspaces/latest/adminguide/workspaces-network-requirements.html\">Amazon WorkSpaces Client Network Requirements</a>.</p>", 1243 "refs": { 1244 "ModifyWorkspaceAccessPropertiesRequest$WorkspaceAccessProperties": "<p>The device types and operating systems to enable or disable for access.</p>", 1245 "WorkspaceDirectory$WorkspaceAccessProperties": "<p>The devices and operating systems that users can use to access Workspaces.</p>" 1246 } 1247 }, 1248 "WorkspaceBundle": { 1249 "base": "<p>Describes a WorkSpace bundle.</p>", 1250 "refs": { 1251 "BundleList$member": null 1252 } 1253 }, 1254 "WorkspaceConnectionStatus": { 1255 "base": "<p>Describes the connection status of a WorkSpace.</p>", 1256 "refs": { 1257 "WorkspaceConnectionStatusList$member": null 1258 } 1259 }, 1260 "WorkspaceConnectionStatusList": { 1261 "base": null, 1262 "refs": { 1263 "DescribeWorkspacesConnectionStatusResult$WorkspacesConnectionStatus": "<p>Information about the connection status of the WorkSpace.</p>" 1264 } 1265 }, 1266 "WorkspaceCreationProperties": { 1267 "base": "<p>Describes the default properties that are used for creating WorkSpaces. For more information, see <a href=\"https://docs.aws.amazon.com/workspaces/latest/adminguide/update-directory-details.html\">Update Directory Details for Your WorkSpaces</a>. </p>", 1268 "refs": { 1269 "ModifyWorkspaceCreationPropertiesRequest$WorkspaceCreationProperties": "<p>The default properties for creating WorkSpaces.</p>" 1270 } 1271 }, 1272 "WorkspaceDirectory": { 1273 "base": "<p>Describes a directory that is used with Amazon WorkSpaces.</p>", 1274 "refs": { 1275 "DirectoryList$member": null 1276 } 1277 }, 1278 "WorkspaceDirectoryState": { 1279 "base": null, 1280 "refs": { 1281 "WorkspaceDirectory$State": "<p>The state of the directory's registration with Amazon WorkSpaces.</p>" 1282 } 1283 }, 1284 "WorkspaceDirectoryType": { 1285 "base": null, 1286 "refs": { 1287 "WorkspaceDirectory$DirectoryType": "<p>The directory type.</p>" 1288 } 1289 }, 1290 "WorkspaceErrorCode": { 1291 "base": null, 1292 "refs": { 1293 "AccountModification$ErrorCode": "<p>The error code that is returned if the configuration of BYOL cannot be modified.</p>", 1294 "Workspace$ErrorCode": "<p>The error code that is returned if the WorkSpace cannot be created.</p>" 1295 } 1296 }, 1297 "WorkspaceId": { 1298 "base": null, 1299 "refs": { 1300 "DescribeWorkspaceSnapshotsRequest$WorkspaceId": "<p>The identifier of the WorkSpace.</p>", 1301 "FailedWorkspaceChangeRequest$WorkspaceId": "<p>The identifier of the WorkSpace.</p>", 1302 "ModifyWorkspacePropertiesRequest$WorkspaceId": "<p>The identifier of the WorkSpace.</p>", 1303 "ModifyWorkspaceStateRequest$WorkspaceId": "<p>The identifier of the WorkSpace.</p>", 1304 "RebootRequest$WorkspaceId": "<p>The identifier of the WorkSpace.</p>", 1305 "RebuildRequest$WorkspaceId": "<p>The identifier of the WorkSpace.</p>", 1306 "RestoreWorkspaceRequest$WorkspaceId": "<p>The identifier of the WorkSpace.</p>", 1307 "StartRequest$WorkspaceId": "<p>The identifier of the WorkSpace.</p>", 1308 "StopRequest$WorkspaceId": "<p>The identifier of the WorkSpace.</p>", 1309 "TerminateRequest$WorkspaceId": "<p>The identifier of the WorkSpace.</p>", 1310 "Workspace$WorkspaceId": "<p>The identifier of the WorkSpace.</p>", 1311 "WorkspaceConnectionStatus$WorkspaceId": "<p>The identifier of the WorkSpace.</p>", 1312 "WorkspaceIdList$member": null 1313 } 1314 }, 1315 "WorkspaceIdList": { 1316 "base": null, 1317 "refs": { 1318 "DescribeWorkspacesConnectionStatusRequest$WorkspaceIds": "<p>The identifiers of the WorkSpaces. You can specify up to 25 WorkSpaces.</p>", 1319 "DescribeWorkspacesRequest$WorkspaceIds": "<p>The identifiers of the WorkSpaces. You cannot combine this parameter with any other filter.</p> <p>Because the <a>CreateWorkspaces</a> operation is asynchronous, the identifier it returns is not immediately available. If you immediately call <a>DescribeWorkspaces</a> with this identifier, no information is returned.</p>" 1320 } 1321 }, 1322 "WorkspaceImage": { 1323 "base": "<p>Describes a WorkSpace image.</p>", 1324 "refs": { 1325 "WorkspaceImageList$member": null 1326 } 1327 }, 1328 "WorkspaceImageDescription": { 1329 "base": null, 1330 "refs": { 1331 "CopyWorkspaceImageRequest$Description": "<p>A description of the image.</p>", 1332 "ImportWorkspaceImageRequest$ImageDescription": "<p>The description of the WorkSpace image.</p>", 1333 "WorkspaceImage$Description": "<p>The description of the image.</p>" 1334 } 1335 }, 1336 "WorkspaceImageErrorCode": { 1337 "base": null, 1338 "refs": { 1339 "WorkspaceImage$ErrorCode": "<p>The error code that is returned for the image.</p>" 1340 } 1341 }, 1342 "WorkspaceImageId": { 1343 "base": null, 1344 "refs": { 1345 "CopyWorkspaceImageRequest$SourceImageId": "<p>The identifier of the source image.</p>", 1346 "CopyWorkspaceImageResult$ImageId": "<p>The identifier of the image.</p>", 1347 "DeleteWorkspaceImageRequest$ImageId": "<p>The identifier of the image.</p>", 1348 "ImportWorkspaceImageResult$ImageId": "<p>The identifier of the WorkSpace image.</p>", 1349 "WorkspaceBundle$ImageId": "<p>The image identifier of the bundle.</p>", 1350 "WorkspaceImage$ImageId": "<p>The identifier of the image.</p>", 1351 "WorkspaceImageIdList$member": null 1352 } 1353 }, 1354 "WorkspaceImageIdList": { 1355 "base": null, 1356 "refs": { 1357 "DescribeWorkspaceImagesRequest$ImageIds": "<p>The identifier of the image.</p>" 1358 } 1359 }, 1360 "WorkspaceImageIngestionProcess": { 1361 "base": null, 1362 "refs": { 1363 "ImportWorkspaceImageRequest$IngestionProcess": "<p>The ingestion process to be used when importing the image.</p>" 1364 } 1365 }, 1366 "WorkspaceImageList": { 1367 "base": null, 1368 "refs": { 1369 "DescribeWorkspaceImagesResult$Images": "<p>Information about the images.</p>" 1370 } 1371 }, 1372 "WorkspaceImageName": { 1373 "base": null, 1374 "refs": { 1375 "CopyWorkspaceImageRequest$Name": "<p>The name of the image.</p>", 1376 "ImportWorkspaceImageRequest$ImageName": "<p>The name of the WorkSpace image.</p>", 1377 "WorkspaceImage$Name": "<p>The name of the image.</p>" 1378 } 1379 }, 1380 "WorkspaceImageRequiredTenancy": { 1381 "base": null, 1382 "refs": { 1383 "WorkspaceImage$RequiredTenancy": "<p>Specifies whether the image is running on dedicated hardware. When Bring Your Own License (BYOL) is enabled, this value is set to <code>DEDICATED</code>. For more information, see <a href=\"https://docs.aws.amazon.com/workspaces/latest/adminguide/byol-windows-images.html\">Bring Your Own Windows Desktop Images</a>.</p>" 1384 } 1385 }, 1386 "WorkspaceImageState": { 1387 "base": null, 1388 "refs": { 1389 "WorkspaceImage$State": "<p>The status of the image.</p>" 1390 } 1391 }, 1392 "WorkspaceList": { 1393 "base": null, 1394 "refs": { 1395 "CreateWorkspacesResult$PendingRequests": "<p>Information about the WorkSpaces that were created.</p> <p>Because this operation is asynchronous, the identifier returned is not immediately available for use with other operations. For example, if you call <a>DescribeWorkspaces</a> before the WorkSpace is created, the information returned can be incomplete.</p>", 1396 "DescribeWorkspacesResult$Workspaces": "<p>Information about the WorkSpaces.</p> <p>Because <a>CreateWorkspaces</a> is an asynchronous operation, some of the returned information could be incomplete.</p>" 1397 } 1398 }, 1399 "WorkspaceProperties": { 1400 "base": "<p>Describes a WorkSpace.</p>", 1401 "refs": { 1402 "ModifyWorkspacePropertiesRequest$WorkspaceProperties": "<p>The properties of the WorkSpace.</p>", 1403 "Workspace$WorkspaceProperties": "<p>The properties of the WorkSpace.</p>", 1404 "WorkspaceRequest$WorkspaceProperties": "<p>The WorkSpace properties.</p>" 1405 } 1406 }, 1407 "WorkspaceRequest": { 1408 "base": "<p>Describes the information used to create a WorkSpace.</p>", 1409 "refs": { 1410 "FailedCreateWorkspaceRequest$WorkspaceRequest": "<p>Information about the WorkSpace.</p>", 1411 "WorkspaceRequestList$member": null 1412 } 1413 }, 1414 "WorkspaceRequestList": { 1415 "base": null, 1416 "refs": { 1417 "CreateWorkspacesRequest$Workspaces": "<p>The WorkSpaces to create. You can specify up to 25 WorkSpaces.</p>" 1418 } 1419 }, 1420 "WorkspaceState": { 1421 "base": null, 1422 "refs": { 1423 "Workspace$State": "<p>The operational state of the WorkSpace.</p>" 1424 } 1425 }, 1426 "WorkspacesDefaultRoleNotFoundException": { 1427 "base": "<p>The workspaces_DefaultRole role could not be found. If this is the first time you are registering a directory, you will need to create the workspaces_DefaultRole role before you can register a directory. For more information, see <a href=\"https://docs.aws.amazon.com/workspaces/latest/adminguide/workspaces-access-control.html#create-default-role\">Creating the workspaces_DefaultRole Role</a>.</p>", 1428 "refs": { 1429 } 1430 }, 1431 "WorkspacesIpGroup": { 1432 "base": "<p>Describes an IP access control group.</p>", 1433 "refs": { 1434 "WorkspacesIpGroupsList$member": null 1435 } 1436 }, 1437 "WorkspacesIpGroupsList": { 1438 "base": null, 1439 "refs": { 1440 "DescribeIpGroupsResult$Result": "<p>Information about the IP access control groups.</p>" 1441 } 1442 } 1443 } 1444} 1445