WorkSpaces Windows client application

The following information will help you get started with the WorkSpaces Windows client application.

Contents

Requirements

Note

WSP WorkSpaces are only supported with Windows client version 5.1.0.329 or higher.

Setup and installation

Download and install the version of the client that you need as follows:

To install. Do this
5.x client Open Amazon WorkSpaces Client Downloads and find the WorkSpaces Windows client. Under Get the latest 64 bit client, choose the Download button.
4.x client Open Previous Versions . Find the WorkSpaces Windows client version and choose the Download button.
3.x client Open Amazon WorkSpaces Client Downloads and find the WorkSpaces Windows client. Under Get the latest 32-bit client, choose the Download button.

You have two choices for how to install the Amazon WorkSpaces Windows client application:

Installing the WorkSpaces client application for all users requires you to have administrator privileges on your local machine. Depending on how your local machine is configured, you might not have such privileges. In that case, you can install the WorkSpaces client application just for yourself. If you have questions about which option to choose, ask your WorkSpaces administrator for guidance.

When installing the client 4.0+ version, you will have an option to install the USB redirection driver for features like Yubikey U2F redirection support. Use the following procedure to install the USB redirection driver.

To install the USB redirection driver
  1. On the Amazon WorkSpaces Setup page, select Install for all users of this machine. Choose Next.

Selection of scope and folder

Selection of install driver for USB redirection

msiexec.exe /i "[path to msi]" /qn INSTALL_USB="1" ALLUSERS="1"

To install the client without PCoIP USB redirection, enter and run the following command in an elevated command prompt.

msiexec.exe /i "[path to msi]" /qn ALLUSERS="1"

If you're having trouble updating your WorkSpaces Windows client application to a newer version, use the following procedure to update your client application.

To update the WorkSpaces Windows client application to a newer version
  1. On your local machine, open the Windows search box and enter registry editor to open the Registry Editor (regedit.exe).
  2. When asked "Do you want to allow this app to make changes to your device?", choose Yes.
  3. In the Registry Editor, navigate to the following registry entry: Computer\HKEY_CURRENT_USER\Software\Amazon Web Services. LLC\Amazon WorkSpaces\WinSparkle
  4. Delete the SkipThisVersion registry key. When prompted to confirm the deletion, choose Yes, and then close the Registry Editor.
  5. If you have not already entered a registration code in the WorkSpaces Windows client application, do so, and then choose Amazon WorkSpaces, Quit Amazon WorkSpaces to close the client application.
  6. Restart the WorkSpaces Windows client application. You should be prompted to update the client. Accept the update.

Determine your client version

To see which version of the WorkSpaces client you have, choose Amazon WorkSpaces, About Amazon WorkSpaces, or click the gear icon in the upper-right corner and choose About Amazon WorkSpaces.

Connect to your WorkSpace

To connect to your WorkSpace, complete the following procedure.

  1. The first time that you run the client application, you are prompted for your registration code, which is contained in your welcome email. The WorkSpaces client application uses the registration code and user name to identify which WorkSpace to connect to. When you launch the client application later, the same registration code is used. To enter a different registration code, launch the client application, and then choose Change Registration Code at the bottom of the login page.
  2. Enter your sign-in credentials in the login screen and choose Sign In. If your WorkSpaces administrator has enabled multi-factor authentication for your organization's WorkSpaces, you are prompted for a passcode to complete your login. Your WorkSpaces administrator will provide more information about how to obtain your passcode.
  3. If your WorkSpaces administrator has not disabled the Keep me logged in feature, you can select the Keep me logged in check box at the bottom of the login screen to save your credentials securely so that you can connect to your WorkSpace easily while the client application remains running. Your credentials are securely cached up to the maximum lifetime of your Kerberos ticket. After the client application connects to your WorkSpace, your WorkSpace desktop is displayed.

An interruption of network connectivity causes an active session to be disconnected. This can be caused by events such as closing the laptop lid, or the loss of your wireless network connection. The WorkSpaces client application for Windows attempts to reconnect the session automatically if network connectivity is regained within a certain amount of time. The default session resume timeout is 20 minutes, but this timeout can be modified by your network administrator.

Manage your login information (3.0+ clients only)

You can view your registration code and what Region your WorkSpace is in. You can specify whether you want the WorkSpaces client application to save your current registration code, and you can assign a name to your WorkSpace. You can also specify if you want Amazon WorkSpaces to keep you logged in to a WorkSpace until you quit or your login period expires.

To manage your login information for a WorkSpace
  1. In the WorkSpaces client application, go to Settings, Manage Login Information.
  2. In the Manage Login Information dialog box, you can see the registration code and Region information for your WorkSpace.
  3. (Optional) If you want the WorkSpaces client to remember your current registration code, select the Remember Registration Code check box.
  4. Under Saved registration codes, select the WorkSpace that you want to name.
  5. In the WorkSpace name box, enter a name for the WorkSpace.
  6. (Optional) If you want WorkSpaces to keep you logged in until you quit or your login period expires, select the Keep me logged in check box.
  7. Choose Save.

Client views

You can switch to full screen mode by choosing View, Enter Full Screen (3.0+ clients) in the client application menu.

While in full screen mode, you can switch back to window mode by moving the pointer to the top of the screen. The client application menu is displayed, and you can choose View, Leave Full Screen (3.0+ clients) in the client application menu.

You can also toggle full screen mode by pressing Ctrl+Alt+Enter.

Client language

You can select the language displayed by the client by performing the following steps.

Note

The WorkSpaces client applications support Japanese. However, Japanese WorkSpaces are available only in the Asia Pacific (Tokyo) Region.

To select the client language
  1. Depending on which client you're using, do one of the following.
If you're using. Do this
3.0+ client In the WorkSpaces client application, go to Settings, Change Language.

Display support

WorkSpaces Value, Standard, Performance, Power, PowerPro, Graphics.g4dn, GraphicsPro.g4dn, and GraphicsPro bundles support a maximum of four displays and a maximum resolution of 3840x2160 (ultra-high definition, or UHD). The maximum supported resolution depends on the number of displays, as shown in the following table.

Note

The WorkSpaces client application extracts the Extended Display Information Data (EDID) of all attached displays and determines the best compatibility match before starting the session. If you have a high pixel density (high DPI) display, the client application automatically scales the streaming window according to your local DPI settings. For better maximum resolution with high DPI displays, see Enabling high DPI display for WorkSpaces.

To use multiple monitors with WorkSpaces
  1. Configure your local machine to use multiple monitors. For more information, see How to use multiple monitors in Windows 10 in the Microsoft documentation.
  2. Start the WorkSpaces client application and log in to your WorkSpace.
  3. Depending on which client you're using, do one of the following:
If you're using. Do this
3.0+ client Choose View, Enter Full Screen On All Displays. You can also toggle full screen mode by pressing Ctrl+Alt+Enter.

Your WorkSpace should now be extended across your displays. Whichever display you have designated as your primary display is also the primary display in WorkSpaces when you enter full screen mode.

Note

Using full screen mode on only some of the displays in a multiple monitor setup isn't possible. You can, however, press the Windows logo key + Up Arrow or use the maximize button in the upper-right corner of the WorkSpaces window to maximize the WorkSpaces client window on a display without extending the WorkSpace to the other displays.

Proxy servers

If your network requires you to use a proxy server to access the internet, you can enable your WorkSpaces client application to use a proxy for HTTPS (port 443) traffic. The WorkSpaces client applications use the HTTPS port for updates, registration, and authentication.

Note

By default, the 3.0+ Windows clients use the proxy server that's specified in the device operating system settings. The first time the client is launched, the device operating system proxy server setting is used. If you select another option for the proxy server, that setting is used for subsequent launches of the client. If a proxy server is specified at both the operating system level and in the WorkSpaces client, the client setting is used.

Starting with version 3.0.12 of the Windows client, you can also choose not to use a proxy server.

Note

In versions 3.0.0 through 3.0.11, if you specify a custom proxy server, a "No network" error might appear when you attempt to log in to your WorkSpace. If you want to use a custom proxy server with the Windows client, we recommend upgrading to the latest version.

  1. In the WorkSpaces client application, go to Settings, Manage Proxy Server.
  2. In the Set Proxy dialog box, select the appropriate options, depending on which version of the 3.0+ client you have.

Command shortcuts

The WorkSpaces Windows client supports the following command shortcuts:

Disconnect

To disconnect the Windows client application, you have several options:

Clipboard support

The clipboard supports a maximum uncompressed object size of 20 MB. For more information, see I'm having trouble copying and pasting.

Note

When copying from a Microsoft Office app, the clipboard only contains the last copied item, and the item is converted into standard format. If you copy content larger than 890 KB from a Microsoft Office app, the app might become slow or unresponsive for up to 5 seconds.

Manage hardware acceleration

Starting with version 5.0.0, hardware acceleration is enabled by default when you're using the Amazon WorkSpaces Windows client application.

Note

If you plan to upgrade to a version between 3.1.4 and 5.0.0, and if you've disabled hardware acceleration for version 3.1.3 or earlier by using the procedure described later in this section, make sure that you re-enable hardware acceleration in Windows by setting the DisableHWAcceleration registry key to 0 . Then you can upgrade to a version between 3.1.4 and 5.0.0 of the WorkSpaces Windows client application.

If you're experiencing high CPU usage or slower performance when using the client, you might want to enable hardware acceleration in the client.

Note

If you enable hardware acceleration in the Windows client, the following issues might occur with a few video driver versions:

  1. Choose Settings, Manage Hardware Acceleration.
  2. In the Manage Hardware Acceleration dialog box, select Enable Hardware Acceleration for Amazon WorkSpaces, and then choose Save.
  3. For this change to take effect, choose Amazon WorkSpaces, Quit Amazon WorkSpaces to close the Windows client application.
  4. Restart the WorkSpaces Windows client application. Hardware acceleration should now be enabled. After you've enabled hardware acceleration in the Windows client, if the screen and mouse issues described earlier occur, clear the Enable Hardware Acceleration for Amazon WorkSpaces check box to disable hardware acceleration, and then restart the Windows client application.

WorkSpaces administrators can enable hardware acceleration in version 3.1.4 or later of the WorkSpaces Windows client by using the following commands in a Command Prompt or PowerShell window.

  1. Use the following command to check for the EnableHwAcc registry key.
reg query "HKCU\SOFTWARE\Amazon Web Services. LLC\Amazon WorkSpaces" /v EnableHwAcc
reg add "HKCU\SOFTWARE\Amazon Web Services. LLC\Amazon WorkSpaces" /v EnableHwAcc

If needed, use the following command to delete the EnableHwAcc registry key.

reg delete "HKCU\SOFTWARE\Amazon Web Services. LLC\Amazon WorkSpaces" /v EnableHwAcc /f

This registry setting takes effect after the WorkSpaces Windows client is closed and restarted.

  1. Choose Settings, Manage Hardware Acceleration.
  2. In the Manage Hardware Acceleration dialog box, unselect Enable Hardware Acceleration for Amazon WorkSpaces, and then choose Save.
  3. For this change to take effect, choose Amazon WorkSpaces, Quit Amazon WorkSpaces to close the Windows client application.
  4. Restart the WorkSpaces Windows client application. Hardware acceleration should now be disabled.
  1. On your Windows computer (not your WorkSpace), open the Windows search box, and enter registry editor to open the Registry Editor (regedit.exe). Choose Run as administrator. (If you don't have permission to run the Registry Editor as an administrator, contact your system administrator for assistance.)
  2. When asked "Do you want to allow this app to make changes to your device?", choose Yes.
  3. In the Registry Editor, navigate to the following registry entry: HKEY_CURRENT_USER\SOFTWARE\Amazon Web Services. LLC\Amazon WorkSpaces
  4. Select Amazon WorkSpaces, and then choose Edit >New >String Value.
  5. For the registry key name, enter EnableHwAcc .
  6. Close the Registry Editor.
  7. Close and restart the WorkSpaces client application. After you've enabled hardware acceleration in the Windows client, if the screen and mouse issues described earlier occur, delete the EnableHwAcc registry key to disable hardware acceleration, and then restart the Windows client application.

WorkSpaces administrators can enable hardware acceleration in version 3.1.4 or later of the WorkSpaces Windows client by using the following commands in a Command Prompt or PowerShell window.

  1. Use the following command to check for the EnableHwAcc registry key.
reg query "HKCU\SOFTWARE\Amazon Web Services. LLC\Amazon WorkSpaces" /v EnableHwAcc
reg add "HKCU\SOFTWARE\Amazon Web Services. LLC\Amazon WorkSpaces" /v EnableHwAcc

If needed, use the following command to delete the EnableHwAcc registry key.

reg delete "HKCU\SOFTWARE\Amazon Web Services. LLC\Amazon WorkSpaces" /v EnableHwAcc /f

This registry setting takes effect after the WorkSpaces Windows client is closed and restarted.

If you need to use version 3.1.3 or earlier of the Windows client application, you can disable hardware acceleration in Windows through the Windows registry. Disabling hardware acceleration in Windows might affect the performance of other Windows applications.

  1. On your Windows computer (not your WorkSpace), open the Windows search box, and enter registry editor to open the Registry Editor (regedit.exe). Choose Run as administrator. (If you don't have permission to run the Registry Editor as an administrator, contact your system administrator for assistance.)
  2. When asked "Do you want to allow this app to make changes to your device?", choose Yes.
  3. In the Registry Editor, navigate to the following registry entry: HKEY_CURRENT_USER\SOFTWARE\Microsoft\Avalon.Graphics
  4. Do one of the following:
  5. If the DisableHWAcceleration registry key exists, select it and choose Edit >Modify. In the Value data box, enter 1 (to disable hardware acceleration), and then choose OK.
  6. If the DisableHWAcceleration registry key doesn't exist, do the following:
    1. Select Avalon.Graphics, and then choose Edit >New >DWORD (32-bit) Value.
    2. For the registry key name, enter DisableHWAcceleration .
    3. Select the new DisableHWAcceleration key, and then choose Edit >Modify.
    4. In the Value data box, enter 1 (to disable hardware acceleration), set Base to Hexadecimal, and then choose OK.
    Note

    If you need to enable hardware acceleration to improve the performance of other Windows applications, set the DisableHWAcceleration key to 0 .

    Diagnostic log upload

    Enabling diagnostic log uploads

    To troubleshoot issues with the WorkSpaces client, you can enable diagnostic logging. The log files that are sent to WorkSpaces include detailed information about your device and connection to the AWS network. You can enable diagnostic log uploads before or during WorkSpace streaming sessions so that these files are sent to WorkSpaces automatically.

    To send log files
    Note

    You can send log files before and during WorkSpaces streaming sessions.

    1. Open your Amazon WorkSpaces client.
    2. At the top of the WorkSpaces sign-in page, choose Manage Diagnostic Logging Settings.
    3. In the pop-up dialog box, choose Enable Diagnostic Logging for Amazon WorkSpaces and click Save.
    Important

    When you report an issue to AWS support, ensure you keep track of the device ID of the client who is experiencing the issue. This device ID can be found in the diagnostics logging menu, in the WorkSpaces client navigation bar, and it helps the support team identify logs associated with your specific device. Ensure you include the device ID in the tickets that you create regarding this specific issue.

    Release notes

    The following table describes the changes to each release of the Windows client application. As a general security best practice, we recommend that WorkSpaces customers update client software as relevant patches become available to obtain the latest updates. For additional information on all the supported WorkSpaces client versions, see WorkSpaces client application end of life policy.

    Bug fixes and enhancements.

    Bug fixes and enhancements.

    Updated WSP SDK.

    Bug fixes and enhancements

    Bug fixes and enhancements

    Added support for automatic diagnostic log uploads feature that allows you to upload WorkSpaces client log files directly to WorkSpaces to troubleshoot issues without interrupting use of the WorkSpaces client.

    Fixed the WorkSpaces login page rendering issues on Windows 8.1

    Updated PCoIP SDK for the WorkSpaces Windows client

    Updated WSP SDK for Windows

    Important

    Client version 4.0 supports Windows 8.1 and Windows 10. Attempting to install version 4.0 on Windows 7 or 8 will result in errors. If you are on Windows 7 or Windows 8, update your OS or download the latest 32 bit client (v3.x) from the Amazon WorkSpaces Client Download page.

    Fixes for disconnects and crashes resulting from WorkSpaces Streaming Protocol (WSP) audio traffic optimization

    Note

    Version 3.1.1 is available only in the AWS GovCloud (US-West) Region

    Minor bug fixes and enhancements

    June 3, 2020 April 28, 2020 March 30, 2020

    Resolves an issue with the user interface displaying a login prompt if single sign-on (SSO) is enabled for Amazon WorkDocs

    March 3, 2020

    Minor bug fixes and enhancements

    February 14, 2020 November 25, 2019 November 4, 2019

    Minor bug fixes

    Resolves an intermittent crashing issue related to computer waking up when opening a laptop lid