Amazon AppStream 2.0
Developer Guide

Install and Configure the AppStream 2.0 Client

You can have your users install the AppStream 2.0 client themselves, or you can install the AppStream 2.0 client for them by running PowerShell scripts remotely.

You must qualify the USB devices that you want to enable your users to use with their streaming session. If their USB device is not qualified, it won't be detected by AppStream 2.0 and can't be shared with the session.

The following topics describe how to install and configure the AppStream 2.0 client.

Have Your Users Install the AppStream 2.0 Client Themselves

If you have your users install the client themselves, you can provide them with the following information. If you qualify USB devices for use with AppStream 2.0, you can also provide your users with the information in the Guidance for Users section in Share a USB Device with an AppStream 2.0 Streaming Session.

Important

If your organization has deployed antivirus software that prevents users from running .exe files, you must add an exception to allow your users to run the AppStream 2.0 client installation .exe program. Otherwise, when users try to install the client, either nothing happens, or they receive an error after they start the installation program.

Guidance for Users

You can use the AppStream 2.0 client to start streaming sessions. To install the client, perform these steps.

  1. Download the AppStream 2.0 client application from AppStream 2.0 supported clients.

  2. Navigate to the location where you downloaded the application .exe file, and double-click the file to begin the installation.

    Important

    If nothing happens when you double-click the file, or an error message displays, contact your network administrator. Your organization may be using antivirus software that prevents the AppStream 2.0 client installation program from running.

  3. The installation wizard displays links to the AWS Customer Agreement, AWS Service Terms, and the AWS Privacy Notice, and third-party notices. Review this information, and choose Next.

  4. On the Client Diagnostics page, to enable the AppStream 2.0 client to automatically upload device logs to help with troubleshooting issues, choose Client logging, and choose Next.

  5. On the Optional Components page, to enable your USB devices to be used with streaming applications, choose AppStream 2.0 Client USB Driver, and choose Finish.

  6. The AppStream 2.0 USB driver wizard setup wizard opens. Choose Install.

  7. If prompted by User Account Control to choose whether to allow the app to make changes to your device, choose Yes.

  8. A message notifies you when the USB driver installation is complete. Choose Close.

  9. The AppStream 2.0 sign-in page opens. If your administrator has provided you with a URL to use to connect to AppStream 2.0 for application streaming, enter the URL, and choose Connect. Otherwise, close the sign-in page.

Next step: If you want to use your USB devices with streaming applications, you must first share your device with AppStream 2.0. For more information, see Share a USB Device with an AppStream 2.0 Streaming Session.

Install the AppStream 2.0 Client for Your Users

If you plan to download and install the client for your users, first download the Enterprise Deployment Tool. You can then run PowerShell scripts to install the AppStream 2.0 client and configure client settings remotely.

Use a Deployment Tool to Install the AppStream 2.0 Client Remotely

To install and configure the AppStream 2.0 client for your users, download the installation files.

  1. Download the Enterprise Deployment Tool from AppStream 2.0 supported clients.

  2. Navigate to the location where you downloaded the tool, right-click the AmazonAppStreamClient_EnterpriseSetup_<version> folder, and choose Extract All. The folder contains the following two installation programs:

    • AmazonAppStreamClientSetup_<version>.msi

    • AmazonAppStreamUsbDriverSetup_<version>.exe

Run a PowerShell Script to Install the AppStream 2.0 Client

After you download the AppStream 2.0 client installation files, run the following PowerShell script on users' computers to silently install the AppStream 2.0 client.

Note

To run this script, you must be logged into the applicable computer with the local Administrator account. You can also run the script remotely under the System account on startup.

Start-Process msiexec.exe -Wait -ArgumentList '/i AmazonAppStreamClientSetup_<version>.msi /quiet' Start-Process AmazonAppStreamUsbDriverSetup_<version>.exe -Wait -ArgumentList '/quiet'

Configure the AppStream 2.0 Client for Your Users

Before your users can start using the AppStream 2.0 client, they must accept the End-User License Agreement (EULA) and choose whether to enable diagnostic logging and USB driver updates. Alternatively, you can define these preferences on behalf of your users. By default, when users open the AppStream 2.0 client, they can only enter URLs that include the AppStream 2.0 domain. However, you can set custom URLs by using the StartUrl registry value. For example, you can set this value to the URL for your organization's login portal. That way, users can sign into AppStream 2.0 by using their existing credentials.

The following table lists the registry values that you can use to customize the AppStream 2.0 client experience for your users.

Note

The values are case-sensitive.

Value Registry path Type Description Data
EULAAccepted HKCU\Software\Amazon\Appstream Client String Set this value to true to accept the AppStream 2.0 client EULA on behalf of your users. true / false
AcceptedEULAVersion HKCU\Software\Amazon\Appstream Client String The version of EULA that is accepted. If the current version of the AppStream 2.0 client EULA is different than the version of the EULA that is accepted, users are prompted to accept the current version of the EULA. 1.0
DiagnosticInfoCollectionAllowed HKCU\Software\Amazon\Appstream Client String Set this value to true to enable AppStream 2.0 to automatically send diagnostic logs from the AppStream 2.0 client to AppStream 2.0. true / false
USBDriverOptIn HKCU\Software\Amazon\Appstream Client String Set this value to true to enable AppStream 2.0 to automatically update the USB driver that is used to pass USB drivers to AppStream 2.0. true / false
StartUrl HKLM\Software\Amazon\Appstream Client String Set this value to configure the URL that automatically launches when your users open the AppStream 2.0 client. Valid URL (for example, https://www.example.com)

Configure the AppStream 2.0 Client through Group Policy

You can use the ADM template that is provided in the AppStream 2.0 client Enterprise Deployment Tool to configure the client through Group Policy. To learn how to load ADM templates into the Group Policy Management Console, see Recommendations for managing Group Policy administrative template (.adm) files in the Microsoft documentation.

Run a PowerShell Script to Create Registry Keys and Set User Preferences

To create the registry keys and set values for user preferences for the AppStream 2.0 client, run the following PowerShell script.

Note

You must set the following entries for each user.

$registryPath="HKCU:\Software\Amazon\AppStream Client" New-Item -Path "HKCU:\Software\Amazon" -Name "AppStream Client" -Force New-ItemProperty -Path $registryPath -Name "EULAAccepted" -Value "true" -PropertyType String -Force | Out-Null New-ItemProperty -Path $registryPath -Name "AcceptedEULAVersion" -Value "1.0" -PropertyType String -Force | Out-Null New-ItemProperty -Path $registryPath -Name "DiagnosticInfoCollectionAllowed" -Value "true" -PropertyType String -Force | Out-Null New-ItemProperty -Path $registryPath -Name "USBDriverOptIn" -Value "true" -PropertyType String -Force | Out-Null

Run a PowerShell Script to Set the Start URL

To set a start URL, run the following PowerShell script. Replace the StartUrl value with a URL for your organization.

Note

To run this script, you must be logged into the applicable computer with the local Administrator account. You can also run the script remotely under the System account on startup.

$registryPath="HKLM:\Software\Amazon\AppStream Client" New-Item -Path "HKLM:\Software\Amazon" -Name "AppStream Client" New-ItemProperty -Path $registryPath -Name "StartUrl" -Value "https://www.example.com" -PropertyType String -Force | Out-Null