baiji v0.6.11 Baiji.Workspaces

Amazon WorkSpaces Service

This reference provides detailed information about the Amazon WorkSpaces operations.

Link to this section Summary

Functions

Returns a map containing the input/output shapes for this endpoint

Outputs values common to all actions

Creates tags for a WorkSpace

Creates one or more WorkSpaces

Deletes tags from a WorkSpace

Describes tags for a WorkSpace

Obtains information about the WorkSpace bundles that are available to your account in the specified region

Retrieves information about the AWS Directory Service directories in the region that are registered with Amazon WorkSpaces and are available to your account

Obtains information about the specified WorkSpaces

Describes the connection status of a specified WorkSpace

Modifies the WorkSpace properties, including the running mode and AutoStop time

Reboots the specified WorkSpaces

Rebuilds the specified WorkSpaces

Starts the specified WorkSpaces. The WorkSpaces must have a running mode of AutoStop and a state of STOPPED

Stops the specified WorkSpaces. The WorkSpaces must have a running mode of AutoStop and a state of AVAILABLE, IMPAIRED, UNHEALTHY, or ERROR

Terminates the specified WorkSpaces

Link to this section Functions

Returns a map containing the input/output shapes for this endpoint

Outputs values common to all actions

Link to this function create_tags(input \\ %{}, options \\ [])

Creates tags for a WorkSpace.

Link to this function create_workspaces(input \\ %{}, options \\ [])

Creates one or more WorkSpaces.

This operation is asynchronous and returns before the WorkSpaces are created.
Link to this function delete_tags(input \\ %{}, options \\ [])

Deletes tags from a WorkSpace.

Link to this function describe_tags(input \\ %{}, options \\ [])

Describes tags for a WorkSpace.

Link to this function describe_workspace_bundles(input \\ %{}, options \\ [])

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.

Link to this function describe_workspace_directories(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.

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.

Link to this function describe_workspaces(input \\ %{}, options \\ [])

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.

Link to this function describe_workspaces_connection_status(input \\ %{}, options \\ [])

Describes the connection status of a specified WorkSpace.

Link to this function modify_workspace_properties(input \\ %{}, options \\ [])

Modifies the WorkSpace properties, including the running mode and AutoStop time.

Link to this function reboot_workspaces(input \\ %{}, options \\ [])

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 returns before the WorkSpaces have rebooted.
Link to this function rebuild_workspaces(input \\ %{}, options \\ [])

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 returns before the WorkSpaces have been completely rebuilt.
Link to this function start_workspaces(input \\ %{}, options \\ [])

Starts the specified WorkSpaces. The WorkSpaces must have a running mode of AutoStop and a state of STOPPED.

Link to this function stop_workspaces(input \\ %{}, options \\ [])

Stops the specified WorkSpaces. The WorkSpaces must have a running mode of AutoStop and a state of AVAILABLE, IMPAIRED, UNHEALTHY, or ERROR.

Link to this function terminate_workspaces(input \\ %{}, options \\ [])

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 returns before the WorkSpaces have been completely terminated.