AWS.Workspaces
Amazon WorkSpaces Service
This is the Amazon WorkSpaces API Reference. This guide provides detailed information about Amazon WorkSpaces operations, data types, parameters, and errors.
Summary↑
| create_workspaces(client, input, options \\ []) | Creates one or more WorkSpaces |
| describe_workspace_bundles(client, input, options \\ []) | Obtains information about the WorkSpace bundles that are available to your account in the specified region |
| describe_workspace_directories(client, input, options \\ []) | Retrieves information about the AWS Directory Service directories in the region that are registered with Amazon WorkSpaces and are available to your account |
| describe_workspaces(client, input, options \\ []) | Obtains information about the specified WorkSpaces |
| reboot_workspaces(client, input, options \\ []) | Reboots the specified WorkSpaces |
| rebuild_workspaces(client, input, options \\ []) | Rebuilds the specified WorkSpaces |
| terminate_workspaces(client, input, options \\ []) | Terminates the specified WorkSpaces |
Functions
Creates one or more WorkSpaces.
This operation is asynchronous and returns before the WorkSpaces are created.
Obtains information about the WorkSpace bundles that are available to your account in the specified region.
You can filter the results with either the BundleIds parameter, or the Owner parameter, but not both.
This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the NextToken response member contains a token that you pass in the next call to this operation to retrieve the next set of items.
Retrieves information about the AWS Directory Service directories in the region that are registered with Amazon WorkSpaces and are available to your account.
This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the NextToken response member contains a token that you pass in the next call to this operation to retrieve the next set of items.
Obtains information about the specified WorkSpaces.
Only one of the filter parameters, such as BundleId, DirectoryId, or WorkspaceIds, can be specified at a time.
This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the NextToken response member contains a token that you pass in the next call to this operation to retrieve the next set of items.
Reboots the specified WorkSpaces.
To be able to reboot a WorkSpace, the WorkSpace must have a State of AVAILABLE, IMPAIRED, or INOPERABLE.
This operation is asynchronous and will return before the WorkSpaces have rebooted.
Rebuilds the specified WorkSpaces.
Rebuilding a WorkSpace is a potentially destructive action that can result in the loss of data. Rebuilding a WorkSpace causes the following to occur:
- The system is restored to the image of the bundle that the WorkSpace is created from. Any applications that have been installed, or system settings that have been made since the WorkSpace was created will be lost.
- The data drive (D drive) is re-created from the last automatic snapshot taken of the data drive. The current contents of the data drive are overwritten. Automatic snapshots of the data drive are taken every 12 hours, so the snapshot can be as much as 12 hours old.
To be able to rebuild a WorkSpace, the WorkSpace must have a State of AVAILABLE or ERROR.
This operation is asynchronous and will return before the WorkSpaces have been completely rebuilt.
Terminates the specified WorkSpaces.
Terminating a WorkSpace is a permanent action and cannot be undone. The user's data is not maintained and will be destroyed. If you need to archive any user data, contact Amazon Web Services before terminating the WorkSpace.
You can terminate a WorkSpace that is in any state except SUSPENDED.
This operation is asynchronous and will return before the WorkSpaces have been completely terminated.