id
stringlengths 8
78
| source
stringclasses 743
values | chunk_id
int64 1
5.05k
| text
stringlengths 593
49.7k
|
|---|---|---|---|
workspaces-ug-005 | workspaces-ug.pdf | 5 | compares the features that are supported by the PCoIP WorkSpaces clients. Feature Windows client MacOS client Linux client iPad client Web access Android Notes ✓ ✓ ✓ ✓ ✓ ✓ Client access restricti on USB redirecti Available with ✗ on exception ✗ N/A ✗ N/A s ✓ ✗ Audio input Video input Storage redirecti ✗ on ✓ ✗ ✗ ✓ ✗ ✗ ✓ ✗ ✗ ✗ ✗ ✗ ✓ ✗ ✗ Control device access WorkSpaces only supports YubiKey redirecti on for Windows clients. For a list of supported devices, see WorkSpaces client periphera l device support. For more informati on on YubiKey redirection, see Hardware security keys. WorkSpaces supports video input on DCV only. Supported PCoIP features for WorkSpaces 10 Amazon WorkSpaces User Guide Feature Windows client MacOS client Linux client iPad client Web access Android Notes ✓ ✓ Local printer redirecti on Clipboard redirecti ✓ on ✓ ✗ ✗ ✓ ✓ ✓ HIPAA/ PCI complianc e ✗ ✗ ✗ Print from a WorkSpaces Available with ✓ exception Available with Copy and paste on iPad and Android exception supports text and s ✓ ✓ s ✓ HTML content only. Compliance and Security FAQ Active directory ✓ authentic ✓ ✓ ✓ ✓ ✓ Manage directories for WorkSpaces ✓ ✗ ✓ ✗ ✓ ✗ ✗ ✗ ✗ ✗ ✗ ✗ ✓ ✓ ✓ ✓ ✓ ✓ Compliance and Security FAQ ation SAML 2.0 Certifica te- based Authentic ation Multi- factor authentic ation (MFA) Supported PCoIP features for WorkSpaces 11 Amazon WorkSpaces User Guide Feature Windows client MacOS client Linux client iPad client Web access Android Notes ✗ ✗ ✓ ✓ ✗ ✗ ✓ ✓ ✗ ✓ ✓ ✓ ✗ ✗ ✗ Smart card (CAC and PIV readers) ✓ ✗ ✓ ✓ ✓ ✓ Certifica te for ✓ access control Encryptio n at ✓ rest Client customiza ✓ tion available YubiKey support ✓ ✗ ✗ ✗ ✗ ✗ WorkSpaces client smart card support Configure the restriction Encryption FAQ Customize WorkSpaces branding Enable USB redirection for YubiKey U2F Monitor support Windows display support macOS display support Linux display support N/A Web access client views Android client views Supported PCoIP features for WorkSpaces 12 Amazon WorkSpaces User Guide WorkSpaces clients You can connect to your WorkSpace using the client application for a supported device or a web browser. To start using your WorkSpace, see Getting started with your WorkSpace. Important WorkSpaces Pool is supported only on the macOS, Web Access, and Windows client Application version 5.20.0 or greater. Clients • WorkSpaces Android client application • WorkSpaces iPad client application • WorkSpaces Linux client application • WorkSpaces macOS client application • WorkSpaces PCoIP zero client • WorkSpaces Web Access • WorkSpaces Windows client application WorkSpaces Android client application The following information will help you get started with the WorkSpaces Android client application. Contents • Requirements • Setup and installation • Connect to your WorkSpace • Gestures • Sidebar menu • Keyboard • Trackpad mode Android/Chromebook 13 Amazon WorkSpaces • Display support • Disconnect • Clipboard support • Release notes Requirements User Guide The Amazon WorkSpaces Android client application requires the following: • Amazon Kindle Fire tablets released after 2012 with Fire OS 4.0 and later. • Android tablets and phones with Android OS 4.4 and later. The client application works on most devices with Android version 4.4 or later, but some devices might not be compatible. Note Versions of the Android client application after 2.4.15 require devices with Android OS 9 and later. Versions of the Android client application after 5.0.0 require devices with Android OS 13 and later. • Chromebooks that support installing Android applications. Chromebooks launched in 2019 or later support installing Android applications. However, some Chromebooks launched before 2019 might not support installing Android applications. We recommend using the Android client application if your Chromebook supports it. To determine whether your Chromebook is compatible with the Amazon WorkSpaces Android client application or whether it requires the Amazon WorkSpaces Chromebook client application, see the installation steps for Chromebooks launched before 2019. • Devices that support running 64-bit applications. Note • The WorkSpaces Android client application is not available for the DCV. • If your WorkSpace is located in the Asia Pacific (Mumbai) Region, you must use version 2.4.19 or later of the Amazon WorkSpaces Android client application. Requirements 14 Amazon WorkSpaces Setup and installation User Guide To download and install the client application, complete the following procedure. (For devices other than Chromebooks launched before 2019) To download and install the client application 1. On your device, open https://clients.amazonworkspaces.com/ and choose the link for your device (either Android/Chromebook or Fire Tablet). 2. Download and install the application. 3. Verify that the Amazon WorkSpaces client application icon appears on one of the device desktops. (For Chromebooks launched before 2019) To download and install the client application |
workspaces-ug-006 | workspaces-ug.pdf | 6 | must use version 2.4.19 or later of the Amazon WorkSpaces Android client application. Requirements 14 Amazon WorkSpaces Setup and installation User Guide To download and install the client application, complete the following procedure. (For devices other than Chromebooks launched before 2019) To download and install the client application 1. On your device, open https://clients.amazonworkspaces.com/ and choose the link for your device (either Android/Chromebook or Fire Tablet). 2. Download and install the application. 3. Verify that the Amazon WorkSpaces client application icon appears on one of the device desktops. (For Chromebooks launched before 2019) To download and install the client application 1. Determine whether your Chromebook supports Android applications by checking its status on the list of Chrome OS Systems Supporting Android Apps. 2. Depending on your Chromebook's status, do one of the following: • If your Chromebook's status is marked as Stable Channel, do the following: 1. Follow the instructions in Install Android apps on your Chromebook to enable your Chromebook to install Android applications. Note In some cases, your WorkSpaces administrator might need to enable your Chromebook to install Android applications. If you are unable to install the Android client application on your Chromebook, contact your WorkSpaces administrator for assistance. 2. On your Chromebook, open https://clients.amazonworkspaces.com/ and choose Android/Chromebook. 3. Download and install the application. 4. Verify that the Amazon WorkSpaces client application icon appears on one of the device desktops. • If your Chromebook's status is marked as Planned or if your Chromebook does not appear on the list, do the following: Setup and installation 15 Amazon WorkSpaces User Guide 1. Determine whether your Chromebook meets the requirements of the Amazon WorkSpaces Chromebook client application: • The WorkSpaces Chromebook client application requires a Chromebook with Chrome OS version 45 or later. The client application works on most Chromebooks with version 45 or later, but some devices might not be compatible. If you have problems with a device, you can report the problem on the WorkSpaces forum. • To check the version of Chrome OS on your Chromebook, go to the status area, where your account picture appears. Choose Settings, About Chrome OS. 2. If your Chromebook is running Chrome OS version 45 or later, open the link to the Amazon WorkSpaces Chromebook client application on the Chrome Web Store. 3. Download and install the application. 4. Verify that the Amazon WorkSpaces client application icon appears in your Chromebook search. Connect to your WorkSpace To connect to your WorkSpace, complete the following procedure. To connect to your WorkSpace 1. On your device, open the Amazon WorkSpaces client application. 2. 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. You can enter a different registration code by launching the client application and tapping Enter new registration code on the login screen. 3. Enter your sign-in credentials and tap 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. 4. If your WorkSpaces administrator has not disabled the "Remember Me" feature, you are prompted to save your credentials securely so that you can connect to your WorkSpace easily in the future. Your credentials will be securely cached up to the maximum lifetime of your Kerberos ticket. Connect to your WorkSpace 16 Amazon WorkSpaces User Guide After the client application connects to your WorkSpace, your WorkSpace desktop is displayed. Gestures The following gestures are supported for the WorkSpaces Android client application. Single tap Equivalent to a single click in Windows. Double tap Equivalent to a double-click in Windows. Two finger single tap Equivalent to a right-click in Windows. Two finger double tap Toggles the on-screen keyboard display. If a keyboard is attached to the device, a set of keyboard shortcuts is shown instead. Swipe from left Displays the sidebar menu. For more information, see Sidebar menu. Two finger scroll Scrolls vertically. Two finger pinch Zooms display in or out. Two finger pan Pans the desktop when zoomed in. Sidebar menu The sidebar menu is displayed by swiping from the left side of the screen. Gestures 17 Amazon WorkSpaces User Guide The sidebar menu provides quick access to the following features: Trackpad Mode – Turns the trackpad on or off. For more information, see Trackpad mode. Show Keyboard – Toggles the display of the on-screen keyboard. If a keyboard is already attached, only a row of keyboard shortcuts is displayed. Settings – Displays controls to change the screen resolution or the |
workspaces-ug-007 | workspaces-ug.pdf | 7 | vertically. Two finger pinch Zooms display in or out. Two finger pan Pans the desktop when zoomed in. Sidebar menu The sidebar menu is displayed by swiping from the left side of the screen. Gestures 17 Amazon WorkSpaces User Guide The sidebar menu provides quick access to the following features: Trackpad Mode – Turns the trackpad on or off. For more information, see Trackpad mode. Show Keyboard – Toggles the display of the on-screen keyboard. If a keyboard is already attached, only a row of keyboard shortcuts is displayed. Settings – Displays controls to change the screen resolution or the scroll direction. Connection Check – Displays the connection status. Sidebar menu 18 Amazon WorkSpaces User Guide Windows Menu – Displays the Windows Start Menu. Disconnect – Disconnects the client application without logging off. Keyboard To toggle the display of the on-screen keyboard, double-tap with two fingers anywhere on the screen. Special key combinations are displayed in the top row of the keyboard. Trackpad mode The trackpad mode is set using the sidebar menu. Trackpad mode off When trackpad mode is off, the mouse cursor is placed wherever you tap your finger. In this mode, a single tap is equivalent to a left mouse button click and a two finger single tap is equivalent to a right mouse button click. Trackpad mode on When trackpad mode is on, the mouse cursor tracks the movement of your finger on the screen. In this mode, simulate a left mouse button click by tapping the left mouse button icon. Simulate a right mouse button click by tapping the right mouse button icon. Keyboard 19 Amazon WorkSpaces Display support User Guide The Amazon WorkSpaces Android client application supports a single monitor. Multiple monitors are not supported. The maximum supported screen resolution depends on your device's display. Although specific screen resolution settings are offered in the Settings menu, if you choose Default, WorkSpaces matches the resolution that you've set on your device. If your device supports a resolution higher than 2800x1752, choose Default if you want WorkSpaces to use a higher resolution. Resolution setting When to use 2800x1752, 2560x1440, 1920x1080, 1600x900, 1280x720, 960x540 Choose one of these settings if you want your display to use this exact resolution. Default High DPI Mode Choose this setting to match the resolutio n that you've set on your device, up to the maximum resolution that your device supports. If you choose Default and you're using a high DPI display, the screen resolutio n is adjusted to a lower one so that text and icons are easier to read. Choose this setting for better maximum resolution of your WorkSpace on high DPI displays. If you choose High DPI Mode and the text and icons on your WorkSpace are smaller than you'd prefer, either choose Default instead, or adjust the scaling settings on your WorkSpace. For more information about high DPI mode and how to adjust the scaling settings on your WorkSpace, see Enabling high DPI display for WorkSpaces. Display support 20 Amazon WorkSpaces Disconnect User Guide To disconnect the Android client, display the sidebar menu, tap the disconnect icon, and tap Disconnect. You can also log off of the WorkSpace, which disconnects the client. Clipboard support The clipboard supports copy and paste of text and HTML content only. The maximum uncompressed object size is 20 MB. For more information, see the section called “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. Release notes Android client application release notes The following table describes the changes to each release of the Android client application. Release 5.1.1 5.0.1 5.0.0 Date Changes April 2, 2025 • Updated PCoIP SDK for Android. • Updated the .NET SDK for Android. • Bug fixes and enhancements. November 6, 2024 Bug fixes and enhancements. February 26, 2024 • Added support for the Israel (Tel Aviv) Region. • Updated PCoIP SDK for Android. Disconnect 21 Amazon WorkSpaces User Guide Release Date Changes 4.0.6 August 18, 2023 • Added accessibility improvements, including screen reader support and keyboard-only navigation enhancement. • Improved client custom branding by storing assets in the same AWS Regions as provision ed WorkSpaces. • Resolved the Spanish keyboard mapping issues. 4.0.5 May 5, 2023 • Added connection support to WorkSpaces provisioned in the AWS GovCloud (US-East) Region • Added accessibility enhancements 4.0.4 4.0.3 December 15, 2022 Updated the .NET framework for the WorkSpaces Android client October 20, 2022 Upgraded target Android API level to continue supporting 64-bit Android 12 and later versions 4.0.2 August 3, 2022 Resolved an issue that |
workspaces-ug-008 | workspaces-ug.pdf | 8 | 4.0.6 August 18, 2023 • Added accessibility improvements, including screen reader support and keyboard-only navigation enhancement. • Improved client custom branding by storing assets in the same AWS Regions as provision ed WorkSpaces. • Resolved the Spanish keyboard mapping issues. 4.0.5 May 5, 2023 • Added connection support to WorkSpaces provisioned in the AWS GovCloud (US-East) Region • Added accessibility enhancements 4.0.4 4.0.3 December 15, 2022 Updated the .NET framework for the WorkSpaces Android client October 20, 2022 Upgraded target Android API level to continue supporting 64-bit Android 12 and later versions 4.0.2 August 3, 2022 Resolved an issue that the touchpad scrolling was too sensitive within WorkSpaces on Chromebooks 4.0.1 May 12, 2022 • Updated PCoIP SDK for the WorkSpaces Android client • Updated WSP SDK for the WorkSpaces Android client 3.0.4 October 14, 2021 • Resolves crashing issues related to invalid cursor data • Bug fixes 3.0.2 July 13, 2021 Minor enhancements and fixes Release notes 22 Amazon WorkSpaces Release 3.0.1 User Guide Date Changes June 30, 2021 • Adds support for self-service WorkSpace management capabilities. • Adds support for certificate-based trusted devices. 2.4.21 May 20, 2021 • Adds 2800x1752 and High DPI Mode in resolution options • Addresses a crash scenario related to cursor rendering • Minor enhancements and fixes Note Because the 32-bit PCoIP SDK for Android has reached the end of support, Version 2.4.21 is the final release of Amazon WorkSpaces Android client, which supports both 32-bit and 64-bit for Android 9 and above. Next release onwards, Amazon WorkSpaces Android client will only support 64-bit. 2.4.20 March 25, 2021 • Addresses a crash issue at login • Minor enhancements and fixes 2.4.19 February 22, 2021 Enhanced support for resolution 2560x1440 Release notes 23 Amazon WorkSpaces Release 2.4.18 Date Changes October 19, 2020 • Adds support for certain Chromebook User Guide models that were previously not supported • Fixes multiple key-mapping issues pertainin g to English, French, and Japanese keyboard layouts • Adds support for faster reconnection to WorkSpaces on Chromebook devices when resuming from sleep mode 2.4.17 2.4.16 February 24, 2020 Minor enhancements and fixes January 30, 2020 Added support for versions above 64-bit Android 9 2.4.15 June 24, 2019 • Adds support for mouse cursor contextual 2.4.14 2.4.13 2.4.12 2.4.11 shape changes • This is the last version that supports versions below Android 8 • Adds support for the Right alt key mapping with Japanese keyboard layouts • Resolves an occasional issue with blue overlay Minor fixes • Resolves an issue that makes the login page bounce on a few devices • Minor fixes • Resolves an issue with content being selected with two-finger scrolling • Minor fixes Release notes 24 Amazon WorkSpaces Release 2.4.10 2.4.9 2.4.7 2.4.6 2.4.5 2.4.4 2.4.2 2.4.0 2.3.4 2.3.3 Release notes Date Changes User Guide Improves support for Japanese keyboard layouts Adds support for Samsung Galaxy Note 9 • Improves clipboard redirection • Improves DeX startup Adds support for uniform resource identifiers (URIs), which enable login orchestration • Adds support for time zone redirection for more Regions: America/Indianapol is America/Indiana/Marengo America/I ndiana/Vevay America/Indiana/Indianapolis • Includes text changes to the Login page user interface Minor improvements to session provision handling • Minor fixes • Improves copy and paste • New logo • Improves the user interface and stability • Addresses a display overlay issue on Android Oreo when a mouse is connected to the device • Adds support for Samsung S8/S8+ screen configurations • Resolves minor issues Localization enhancements 25 Amazon WorkSpaces Release 2.2.0 2.1.0 2.0.0 1.0.15 1.0.11 1.0.10 1.0.9 1.0 Date Changes User Guide • Adds support for the German language • Improves the Japanese user interface • Improves stability • Adds support for the following new WorkSpace states: STOPPING and STOPPED • Adds support for audio in, enabling you to make calls or attend web conferences • Resolves minor issues and improves stability • Adds support for saving registration codes, enabling you to switch WorkSpaces without re-entering the registration codes • Improves usability and stability • Adds advanced connection health checks, enabling you to troubleshoot connection issues • Improves stability • Improves the user interface and login experience • Adds support for choosing the screen resolution • Adds support for choosing the scrolling direction • Improves the login experience • Adds time zone synchronization between the local device and the WorkSpace Improves the login experience Initial release Release notes 26 Amazon WorkSpaces User Guide Chromebook client application release notes The following table describes the changes to each release of the Chromebook client application. Note Version 2.4.13 is the final release of the Amazon WorkSpaces Chromebook client application. Because Google is phasing out support for Chrome Apps, there will be no further updates to the WorkSpaces Chromebook client application, and its use is unsupported. Release 2.4.13 2.4.12 2.4.11 2.4.10 |
workspaces-ug-009 | workspaces-ug.pdf | 9 | support for choosing the scrolling direction • Improves the login experience • Adds time zone synchronization between the local device and the WorkSpace Improves the login experience Initial release Release notes 26 Amazon WorkSpaces User Guide Chromebook client application release notes The following table describes the changes to each release of the Chromebook client application. Note Version 2.4.13 is the final release of the Amazon WorkSpaces Chromebook client application. Because Google is phasing out support for Chrome Apps, there will be no further updates to the WorkSpaces Chromebook client application, and its use is unsupported. Release 2.4.13 2.4.12 2.4.11 2.4.10 2.4.8 2.4.7 2.4.6 2.4.5 Date Changes April 24, 2019 Fixed an issue that causes the app not to restore to full-screen mode after a screen unlock Minor bug fixes Minor bug fixes Improves support for Japanese keyboard layouts Improves support for UK keyboards • Improves clipboard redirection • Adds support for tap-to-click for trackpads • Improves device resolution • Resolves an issue that causes screens to freeze • Resolves trackpad issues • Adds support for time zone redirection for more Regions: America/Indianapol is America/Indiana/Marengo America/I ndiana/Vevay America/Indiana/Indianapolis Release notes 27 Amazon WorkSpaces User Guide Release Date Changes 2.4.4 2.4.2 2.4.0 2.2.7 2.2.4 2.2.1 2.1.3 2.0.0 1.0 • Includes text changes to the Login page user interface Minor improvements to session provision handling Resolves a bug with Caps Lock • New logo • Improves the user interface and stability Resolves minor issues Localization enhancements • Adds support for the German language • Improves the Japanese user interface • Improves stability • Adds support for the following new WorkSpace states: STOPPING and STOPPED • Adds support for audio in, enabling you to make calls or attend web conferences • Resolves minor bugs and improves stability • Adds support for saving registration codes, enabling you to switch WorkSpaces without re-entering the registration codes • Improves usability and stability Initial release WorkSpaces iPad client application The following information will help you get started with the WorkSpaces iPad client application. iPad 28 User Guide Amazon WorkSpaces Contents • Requirements • Setup and installation • Connect to your WorkSpace • Gestures • Radial menu • Keyboard and command shortcuts • Mouse modes • Swiftpoint GT, ProPoint, or PadPoint mouse • Disconnect • Clipboard support • Release notes Requirements The WorkSpaces iPad client application requires the following: • iPad 2 or later with iOS 8.0 to 17.0 • iPad Retina with iOS 8.0 to 17.0 • iPad Mini with iOS 8.0 to 17.0 • iPad Pro with iOS 9.0 to 17.0 Note • The Amazon WorkSpaces iPad client application is not available for the DCV. • If your WorkSpace is located in the Asia Pacific (Mumbai) Region, you must use version 2.4.17 or later of the Amazon WorkSpaces iPad client application. • If your iPad is using iPadOS 14.5 to 17.0, we recommend using version 2.4.18 or later of the Amazon WorkSpaces iPad client application. Requirements 29 Amazon WorkSpaces Setup and installation User Guide To download and install the client application, complete the following procedure. To download and install the client application 1. On your iPad, open Amazon WorkSpaces Client Downloads and choose the iPad link. 2. Download and install the application. 3. Verify that the Amazon WorkSpaces client application icon appears on one of the iPad desktops. Connect to your WorkSpace To connect to your WorkSpace, complete the following procedure. To connect to your WorkSpace 1. On your iPad, open the Amazon WorkSpaces client application. 2. 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. You can enter a different registration code by launching the client application and choosing Enter new registration code on the login screen. 3. Enter your sign-in credentials 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. 4. If your WorkSpaces administrator has not disabled the "Remember Me" feature, you are prompted to save your credentials securely so that you can connect to your WorkSpace easily in the future. Your credentials will be securely cached up to the maximum lifetime of your Kerberos ticket. After the client application connects to your WorkSpace, your WorkSpace desktop is displayed. Setup and installation 30 Amazon WorkSpaces Gestures User Guide The following gestures are supported for the WorkSpaces iPad client application. Single tap Equivalent to a single click in Windows. Double tap Equivalent to a double click in Windows. Two finger |
workspaces-ug-010 | workspaces-ug.pdf | 10 | 4. If your WorkSpaces administrator has not disabled the "Remember Me" feature, you are prompted to save your credentials securely so that you can connect to your WorkSpace easily in the future. Your credentials will be securely cached up to the maximum lifetime of your Kerberos ticket. After the client application connects to your WorkSpace, your WorkSpace desktop is displayed. Setup and installation 30 Amazon WorkSpaces Gestures User Guide The following gestures are supported for the WorkSpaces iPad client application. Single tap Equivalent to a single click in Windows. Double tap Equivalent to a double click in Windows. Two finger single tap Equivalent to a right-click in Windows. Two finger double tap Toggles the on-screen keyboard display. Swipe from left Displays the radial menu. For more information, see Radial menu. Two finger scroll Scrolls vertically. Two finger pinch Zooms display in or out. Two finger pan Pans the desktop when zoomed in. Radial menu The radial menu is displayed by swiping from the left side of the screen. Gestures 31 Amazon WorkSpaces User Guide The radial menu provides quick access to the following features: Settings – Displays controls to change the screen resolution, change the scroll direction, or connect or disconnect the Swiftpoint GT, ProPoint, or PadPoint mouse. Connection Status – Displays the connection status of the WorkSpace. Disconnect – Disconnects the client application without logging off. Direct Mouse Mode – Sets the input to direct mouse mode. For more information, see Mouse modes. Radial menu 32 Amazon WorkSpaces User Guide Help – Displays the command and gesture tutorial. Keyboard – Toggles the display of the on-screen keyboard. Windows Start Menu – Displays the Windows Start Menu. Offset Mouse Mode – Sets the input to offset mouse mode. For more information, see Mouse modes. Keyboard and command shortcuts To toggle the display of the on-screen keyboard, double-tap with two fingers anywhere on the screen. Special key combinations (command shortcuts) that are frequently used in Windows, such as Ctrl+Alt+Del, Alt+Tab, Ctrl+A, Ctrl+C, Ctrl+V, Ctrl+X, and so on, are displayed in the top row of the on-screen keyboard. If you have a full-size physical keyboard attached to your iPad, you can use Control+Option+Delete to send Ctrl+Alt+Del to your Windows WorkSpace. (Be sure to use the forward Delete key, not the backspace Delete key.) Mouse modes The mouse mode is set using the radial menu. Keyboard and command shortcuts 33 Amazon WorkSpaces Direct mode User Guide In direct mouse mode, the mouse cursor is placed wherever you tap your finger. In this mode, a single tap is equivalent to a left mouse button click and a two finger single tap is equivalent to a right mouse button click. Offset mode In offset mouse mode, the mouse cursor tracks the movement of your finger on the screen. In this mode, simulate a left mouse button click by tapping the left mouse button icon. Simulate a right mouse button click by tapping the right mouse button icon. Swiftpoint GT, ProPoint, or PadPoint mouse You can use the Swiftpoint GT, ProPoint, or PadPoint mouse on an iPad to interact with your WorkSpace. To do so, before you launch the Amazon WorkSpaces iPad client application, enable Bluetooth on your iPad and pair the Swiftpoint mouse with your iPad (the Swiftpoint mouse should pair automatically). To connect the Swiftpoint mouse and your iPad client, display the radial menu, and tap Settings. For SwiftPoint GT Mouse, choose Connect. Note Although the Swiftpoint GT mouse is no longer available, you can use the Swiftpoint ProPoint and PadPoint mice with the Amazon WorkSpaces iPad client application instead. The Swiftpoint TRACPOINT, PenPoint, and GoPoint mice aren't supported for use with the WorkSpaces iPad client. For more information, see Swiftpoint GT Mouse. iPads with iPadOS 13.4 or later also support Bluetooth mice. For more information, see Use a Bluetooth mouse or trackpad with your iPad in the Apple Support documentation. Swiftpoint GT, ProPoint, or PadPoint mouse 34 Amazon WorkSpaces Disconnect User Guide To disconnect the iPad client application, display the radial menu, tap the disconnect icon, and tap Disconnect. You can also log off of the WorkSpace, which disconnects the client. To quit the WorkSpaces iPad client application 1. Open the App Switcher by doing one of the following: • Swipe up from the bottom edge and pause in the center of the screen. • Double-click the Home button (on an iPad with a Home button). 2. Swipe up on the WorkSpaces iPad client application to close it. Clipboard support The clipboard supports copy and paste of text and HTML content only. The maximum uncompressed object size is 20 MB. For more information, see the section called “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 |
workspaces-ug-011 | workspaces-ug.pdf | 11 | by doing one of the following: • Swipe up from the bottom edge and pause in the center of the screen. • Double-click the Home button (on an iPad with a Home button). 2. Swipe up on the WorkSpaces iPad client application to close it. Clipboard support The clipboard supports copy and paste of text and HTML content only. The maximum uncompressed object size is 20 MB. For more information, see the section called “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. Release notes The following table describes the changes to each release of the iPad client application. Release Date Changes 2.4.27 2.4.26 Disconnect February 12, 2025 Bug fixes and enhancements. November 13, 2024 Bug fixes and enhancements. 35 Amazon WorkSpaces Release 2.4.25 User Guide Date Changes October 7, 2023 Improved client custom branding by storing assets in the same AWS Regions as provisioned WorkSpaces. 2.4.24 May 9, 2023 • Added connection support to WorkSpaces provisioned in the AWS GovCloud (US-East) Region. • Added accessibility enhancements. 2.4.21 August 3, 2022 • Added support for a new Region. 2.4.20 April 30, 2022 2.4.19 Oct 20, 2021 2.4.18 May 9, 2021 • Minor bug fixes and enhancements. Fixed screen refresh issue that occurred when changing display resolution during active sessions. Resolves the issue of users not being able to close the on-screen keyboard in iPadOS 15. Addresses the crash on startup issue on iPadOS 14.5 2.4.17 2.4.16 2.4.15 February 18, 2021 Improved Japanese keyboard support September 27, 2020 Minor bug fixes and enhancements June 28, 2020 • Adds native mouse and trackpad support on iPadOS 13.4+ • Fixes instances of keyboard shortcuts not working from external keyboards on iPadOS 13.4+ • Includes improved error messaging and mouse pointer related UI enhancements • Minor bug fixes Release notes 36 Amazon WorkSpaces User Guide Release 2.4.14 2.4.13 2.4.11 2.4.9 2.4.7 2.4.6 2.4.5 2.4.4 Date Changes April 17, 2020 • Running the client application on a jailbroke n device is no longer supported • Minor bug fixes February 28, 2020 Minor bug fixes October 28, 2019 • Resolves an issue that can periodically result in repeated key presses with WorkSpaces running Amazon Linux 2 • Resolves an issue with reconnecting to WorkSpaces • Minor bug fixes Minor bug fixes Closing the WorkSpaces client app now expires the reconnect token. You can only reconnect to your WorkSpace when the client app is running. Minor fixes to the on-screen keyboard Adds support for uniform resource identifiers (URIs), which enable login orchestration • Adds support for time zone redirection for more Regions: America/Indianapol is America/Indiana/Marengo America/I ndiana/Vevay America/Indiana/Indianapolis • Includes text changes to the Login page user interface 2.4.3 • Adds support for the Swiftpoint GT mouse scroll wheel • Minor improvements to session provision handling Release notes 37 Amazon WorkSpaces Release 2.4.2 2.4.0 2.2.4 2.2.3 2.2.0 2.1.0 Date Changes User Guide • Minor fixes • Improves copy and paste • Adds initial support for the Swiftpoint GT mouse (the scroll wheel is not supported) • New logo • Improves the user interface and stability Localization enhancements • Enables ATS to support HTTPS TLS 1.2 • Adds a microphone privacy statement • Improves the default resolution for iPad Pro models • Improves localization in multiple languages • Resolves a black screen issue on 9.7-inch iPad Pro models • Resolves the app icon zooming issue on iOS 10 • Resolves an audio echo issue • Security fixes and various improvements • Adds support for audio session managemen t, enabling you to play music in the background while using WorkSpaces • Adds support for the German language • Adds support for local IPv6 networking • Adds support for the following new WorkSpace states: STOPPING and STOPPED • Resolves minor bugs and improves stability Release notes 38 Amazon WorkSpaces Release 2.0.0 1.1 1.0.11 1.0.10 1.0.9 1.0.8 1.0.7 1.0.6 Date Changes User Guide • Adds support for saving registration codes, enabling you to switch WorkSpaces without re-entering the registration codes • Resolves an issue with arrow key support on Bluetooth keyboards • Resolves an issue with Bluetooth keyboards inadvertently activating the on-screen shortcut bar • Improves usability and stability • Adds advanced connection health checks, enabling you to troubleshoot connection issues • Improves stability Improves stability on iOS 8 Improves stability • Improves the user interface and login experience • Adds support for choosing the screen resolution • Adds support for choosing the scrolling direction • Improves error messages • Improves the Bluetooth keyboard experienc e • Improves the scrolling experience Improves the login experience |
workspaces-ug-012 | workspaces-ug.pdf | 12 | without re-entering the registration codes • Resolves an issue with arrow key support on Bluetooth keyboards • Resolves an issue with Bluetooth keyboards inadvertently activating the on-screen shortcut bar • Improves usability and stability • Adds advanced connection health checks, enabling you to troubleshoot connection issues • Improves stability Improves stability on iOS 8 Improves stability • Improves the user interface and login experience • Adds support for choosing the screen resolution • Adds support for choosing the scrolling direction • Improves error messages • Improves the Bluetooth keyboard experienc e • Improves the scrolling experience Improves the login experience Improves the login experience Release notes 39 Amazon WorkSpaces Release 1.0.5 1.0.4 1.0.3 1.0.2 1.01 1.0 Date Changes User Guide • Improves the login experience • Improves network connectivity Improves the login experience Improves the login experience • Adds connection health checks • Resolves specific issues with the iPad Air and iPad mini Improves radial functionality Initial release WorkSpaces Linux client application The following information will help you get started with the WorkSpaces Linux client application. Contents • Requirements • Setup and installation • Connecting to your WorkSpace • Manage your login information • Client views • Client language • Display support • Proxy servers • Command shortcuts • Clipboard redirection • Disconnect • Release notes Linux 40 Amazon WorkSpaces Requirements User Guide For the WorkSpaces Linux client version 2023.x to be able to access the WorkSpaces service, you must add the WorkSpaces Web Access domain (https://webclient.amazonworkspaces.com/) to the allowlist on the network from which the client is trying to access the service. Note • By default, Linux client access is disabled. To use this client with your WorkSpace, your Amazon WorkSpaces administrator must enable Linux client access for your WorkSpaces directory. For more information, see Control Device Access in the Amazon WorkSpaces Administration Guide. • If your WorkSpace is located in the Asia Pacific (Mumbai) Region, you must use version 3.1.3 or later of the Amazon WorkSpaces Linux client application. • The WorkSpaces Linux client version 2023.0.4395 for Ubuntu 22.04 is only available for the DCV. Setup and installation Download and install the WorkSpaces Linux client application from Amazon WorkSpaces Client Downloads. Detailed installation instructions are included on the Linux client page on the Client Downloads site. 2023.x clients To launch the Linux client from the command line, use: workspacesclient Note When running a new client application, you will be prompted for your registration code, which is can be found in your welcome email. For existing customers, you can find the registration code under /home/UserName/.local/share/Amazon Web Services/ Amazon WorkSpaces/RegisterationList.json. Requirements 41 Amazon WorkSpaces 3.x and 4.x clients User Guide To launch the Linux client from the command line, use: /opt/workspacesclient/workspacesclient Connecting to your WorkSpace To connect to your WorkSpace, complete the following procedure. To connect to your WorkSpace 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 Linux 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. Connecting to your WorkSpace 42 Amazon WorkSpaces User Guide Manage your login information 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 |
workspaces-ug-013 | workspaces-ug.pdf | 13 | of your wireless network connection. The WorkSpaces client application for Linux 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. Connecting to your WorkSpace 42 Amazon WorkSpaces User Guide Manage your login information 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. 2023.x clients To manage your login information for a WorkSpace 1. 2. 3. In the WorkSpaces client application, go to Settings, Manage Login Information. In the Settings dialog box, you can see the registration code and Region information for your WorkSpace. (Optional) If you want the WorkSpaces client to remember your current registration code, enable Save registration code. 4. Under Saved registration codes, select the WorkSpace you want to name. 5. 6. In the WorkSpace name box, enter a name for the WorkSpace. (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. 3.x and 4.x clients To manage your login information for a WorkSpace 1. 2. 3. In the WorkSpaces client application, go to Settings, Manage Login Information. In the Manage Login Information dialog box, you can see the registration code and Region information for your WorkSpace. (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 you want to name. 5. 6. In the WorkSpace name box, enter a name for the WorkSpace. (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. Manage your login information 43 Amazon WorkSpaces Client views Full screen mode for 2023.x clients User Guide You can switch to full screen mode by selecting the full screen icon 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 Leave Full Screen in the client application menu. Full screen mode for 3.x and 4.x clients You can switch to full screen mode by choosing View, Enter Full Screen 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 in the client application menu. You can also toggle full screen mode by pressing Ctrl+Alt+Enter. Client language 2023.x clients The WorkSpaces client automatically selects the default display language used by the operating system on your computer. 3.x and 4.x clients You can select the language displayed by the client by performing the following steps. Note In the client, Japanese is available in all Regions. However, Japanese is only available in Tokyo for individual WorkSpaces. To select the client language 1. In the WorkSpaces client application, go to Settings, Change Language. Client views 44 Amazon WorkSpaces User Guide 2. Enter your desired language in the Select a language list and choose Save. 3. Restart the client. Display support WorkSpaces Value, Standard, Performance, Power, PowerPro, 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. Displays 2 4 Note Resolution 3840x2160 1920x1200 • You can only extend the display. You cannot duplicate the display. Duplicating the display will cause your session to be disconnected. • Graphics bundles support only a single monitor configuration with a maximum resolution of 2560x1600. 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. 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: Display support 45 Amazon WorkSpaces |
workspaces-ug-014 | workspaces-ug.pdf | 14 | 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. 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: Display support 45 Amazon WorkSpaces Note User Guide If you are using client version is 2023.x with DCV WorkSpaces, and if there are three or more monitors connected, your WorkSpace can also extend full-screen across a selection of those available monitors. Selected monitors must be set adjacent or sharing a side with each other, in your display setting. DCV multi-monitor support is built using DCV technology. For more information about requirements and troubleshooting, see Extending full-screen across selected monitors. If you're using... 2023.x+ client 3.0+ and 4.0+ client 2.0+ client Do this • Choose Across a single monitor to enter full screen mode on a single display (DCV only) • Choose Across selective monitors to enter full screen mode on selected displays (DCV only) • Choose Across all monitors to extend full screen mode on all display (for both PCoIP and DCV) • Toggle full screen mode by pressing Ctrl +Alt+Enter (PCoIP only) Choose View, Enter Full Screen On All Displays. You can also toggle full screen mode by pressing Ctrl+Alt+Enter. Choose View, Show Fullscreen. 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. Display support 46 Amazon WorkSpaces Note User Guide Using full screen mode on only some of the displays in a multiple monitor setup isn't possible. You can, however, press Alt+F10 or double-click the title bar 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 • The desktop streaming connections to the WorkSpace require ports 4172 and 4195 to be enabled, and do not go through the proxy server. • Proxy servers that require authentication with a sign-in credentials are not supported. Using a proxy server By default, the Linux client uses 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. Note In versions 3.0.0 through 3.1.4, 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 Linux client, we recommend upgrading to version 3.1.5. If you can't upgrade, you can work around the issue by using the default operating system proxy server instead of specifying a custom proxy server in the Linux client. Proxy servers 47 Amazon WorkSpaces 2023.x clients To use a proxy server User Guide 1. 2. In the WorkSpaces client application, from the login page, choose the three-line menu icon, Connection Settings. In the Connection Settings dialog box, choose Customize proxy server for WorkSpaces , enter the proxy server URL or IP address, enter the port, and choose Save. 3.x and 4.x clients To use a proxy server 1. 2. In the WorkSpaces client application, go to Settings, Manage Proxy Server. In the Set Proxy dialog box, select Use proxy server, enter the proxy server URL or IP address and the port, and choose Save. Command shortcuts The PCoIP WorkSpaces Linux client supports the following command shortcuts: • Ctrl+Alt+Enter—Toggle full screen display (PCoIP only) Clipboard redirection Clipboard supports a maximum uncompressed object size of 20 MB. For more information, see I'm having trouble copying and pasting. Disconnect To disconnect the Linux client application, you have several options. 2023.x clients • In theWorkSpaces streaming session, end the WorkSpace session by closing the window. In the dialog box, choose Disconnect to end your WorkSpace session. The client application will continue running if you want to login again. Command shortcuts 48 Amazon WorkSpaces User Guide • In the WorkSpaces streaming session, end your WorkSpace session by clicking on the three-line menu icon and choosing |
workspaces-ug-015 | workspaces-ug.pdf | 15 | display (PCoIP only) Clipboard redirection Clipboard supports a maximum uncompressed object size of 20 MB. For more information, see I'm having trouble copying and pasting. Disconnect To disconnect the Linux client application, you have several options. 2023.x clients • In theWorkSpaces streaming session, end the WorkSpace session by closing the window. In the dialog box, choose Disconnect to end your WorkSpace session. The client application will continue running if you want to login again. Command shortcuts 48 Amazon WorkSpaces User Guide • In the WorkSpaces streaming session, end your WorkSpace session by clicking on the three-line menu icon and choosing Disconnect. The client application will continue running, which allows you to login again. 3.x and 4.x clients • In the Amazon WorkSpaces client application, go to Amazon WorkSpaces, and then choose Disconnect WorkSpace. Your WorkSpace session ends, but the client application continues running in case you want to log in again. • In the Amazon WorkSpaces client application, go to Amazon WorkSpaces, and then choose Quit Amazon WorkSpaces. Your WorkSpace session ends, and the client application closes. • In the Amazon WorkSpaces client application, close the WorkSpaces client window by clicking the close (X) button in the upper-right corner. • In the Amazon WorkSpaces client application, go to Amazon WorkSpaces, and then choose Disconnect WorkSpace. Your WorkSpace session ends, but the client application continues running in case you want to log in again. • In the Amazon WorkSpaces client application, go to Amazon WorkSpaces, and then choose Quit Amazon WorkSpaces. Your WorkSpace session ends, and the client application closes. • In the Amazon WorkSpaces client application, close the WorkSpaces client window by clicking the close (X) button in the upper-right corner. In the prompt choose End Session , this disconnects you from the Amazon WorkSpaces and closes the client application. Diagnostic log upload To troubleshoot issues with the WorkSpaces client, ensure that diagnostic logging is enabled for your client. 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. Note You can send log files before and during WorkSpaces streaming sessions. Log upload is supported only on Linux Ubuntu 20.04 and Ubuntu 22.04 clients. Disconnect 49 Amazon WorkSpaces To send log files 1. Open your Amazon WorkSpaces client. User Guide 2. 3. In the top right of the WorkSpaces sign-in page after registration, choose Settings and then Diagnostic logging. In the pop-up dialog box, set the toggle under Diagnostic Logging to your desired preference and choose Save. 4. You can choose the amount of data you want to provide in your session logs by selecting a radio button under Log Level. You can choose either Standard logging (default) or Advance logging. Important When you report an issue to Support, ensure you keep track of the device ID of the client that is experiencing the issue. The device ID can be found in the settings diagnostics logging menu on the client login page after entering a registration code. This helps the support team identify logs associated with your specific device. Include the device ID in the tickets that you create regarding your specific issue. Release notes WorkSpaces client application for Ubuntu 22.04 release notes The following table describes the changes to each release of the Ubuntu 22.04 client application. Release 2024.8 Date Changes December 11, 2024 • Added persistent webcam and microphon e settings that are saved between DCV WorkSpaces sessions. • Bug fixes and enhancements. 2024.7 October 10, 2024 • Renamed WSP protocol to Amazon DCV protocol. Release notes 50 Amazon WorkSpaces User Guide Release Date Changes • Added support for streaming over port 443 for TCP and UDP protocols on DCV WorkSpaces. • Added support for certificate-based authentication that enables a single sign-on login experience, with fewer user prompts. • Bug fixes and enhancements. August 26, 2024 Bug fixes and enhancements. August 15, 2024 Bug fixes and enhancements. August 8, 2024 • Updated DCV SDK. • Updated the PCoIP SDK. • Added support for streaming over TCP/UDP port 443. July 3, 2024 Bug fixes and enhancements. June 11, 2024 • Updated DCV SDK. • Added SAML 2.0 integration support. • Added pre-session smart cards authentic ation support. 2024.5 2024.4 2024.3 2024.2 2024.1 2024.0 February 28, 2024 • Updated DCV SDK. • Fixed the keyboard capture issue • Added WebAuthn support for in-session authentication • Minor bug fixes and enhancements. 2023.2 December 19, 2023 • Added screen reader and keyboard navigatio n to improve accessibility. • Added support for AWS GovCloud (US-West) and AWS GovCloud (US-East). Release notes 51 Amazon WorkSpaces Release 2023.1 Date Changes November 12, 2023 • Added Uniform Resource Identifier (URI) User Guide support. • Fixed |
workspaces-ug-016 | workspaces-ug.pdf | 16 | 2024 • Updated DCV SDK. • Added SAML 2.0 integration support. • Added pre-session smart cards authentic ation support. 2024.5 2024.4 2024.3 2024.2 2024.1 2024.0 February 28, 2024 • Updated DCV SDK. • Fixed the keyboard capture issue • Added WebAuthn support for in-session authentication • Minor bug fixes and enhancements. 2023.2 December 19, 2023 • Added screen reader and keyboard navigatio n to improve accessibility. • Added support for AWS GovCloud (US-West) and AWS GovCloud (US-East). Release notes 51 Amazon WorkSpaces Release 2023.1 Date Changes November 12, 2023 • Added Uniform Resource Identifier (URI) User Guide support. • Fixed Japanese keyboard mapping issue for tilde key. • Added diagnostic log upload support. 2023.0.4395 August 24, 2023 • Added DCV WorkSpaces connection support, including Windows, BYOL, and Ubuntu WorkSpaces. • Added full screen mode expansion support on select monitors, if there are more than 2 connected monitors. • Added bi-directional audio/video and webcam redirection support for better conferencing experience. • Added options to display streaming metrics, including frame rate, network latency, and download bandwidth inside their WorkSpaces. Note Uniform Resource Identifier (URI) is not supported in this version. For more information, see Customize how users log in to their WorkSpaces WorkSpaces client application for Ubuntu 20.04 release notes The following table describes the changes to each release of the Ubuntu 20.04 client application. Release notes 52 Amazon WorkSpaces Release 2024.8 User Guide Date Changes December 11, 2024 • Added persistent webcam and microphon e settings that are saved between DCV WorkSpaces sessions. • Bug fixes and enhancements. 2024.7 October 10, 2024 • Renamed WSP protocol to Amazon DCV protocol. • Added support for streaming over port 443 for TCP and UDP protocols on DCV WorkSpaces. • Added support for certificate-based authentication that enables a single sign-on login experience, with fewer user prompts. • Updated the PCoIP SDK. • Bug fixes and enhancements. 2024.6 2024.5 2024.4 2024.3 2024.2 2024.1 September 5, 2024 Bug fixes and enhancements. August 26, 2024 Bug fixes and enhancements. August 15, 2024 Bug fixes and enhancements. August 8, 2024 • Updated DCV SDK. • Updated the PCoIP SDK. • Added support for streaming over TCP/UDP port 443. July 3, 2024 Bug fixes and enhancements. June 11, 2024 • Updated DCV SDK. • Added SAML 2.0 integration support. 2024.0 February 28, 2024 • Updated DCV SDK. • Updated PCoIP SDK. • Fixed the keyboard capture issue Release notes 53 Amazon WorkSpaces User Guide Release Date Changes • Added WebAuthn support for in-session authentication • Minor bug fixes and enhancements. 2023.2 December 19, 2023 • Added screen reader and keyboard navigatio n to improve accessibility. • Added support for AWS GovCloud (US-West) and AWS GovCloud (US-East). 2023.1 November 12, 2023 • Added Uniform Resource Identifier (URI) support. • Fixed Japanese keyboard mapping issue for tilde key. • Added diagnostic log upload support 4.7.0 November 1, 2023 • Added support for Israel (Tel Aviv) Region. • Fixed Japanese keyboard mapping issue for tilde key. • Updated PCoIP SDK for Linux. Release notes 54 Amazon WorkSpaces User Guide Release Date Changes 2023.0.4430 August 24, 2023 • Added DCV WorkSpaces connection support, including Windows, BYOL, and Ubuntu WorkSpaces. • (DCV only) Added full screen mode expansion support on select monitors, if there are more than 2 connected monitors. • (DCV only) Added bi-directional audio/video and webcam redirection support for better conferencing experience. • (DCV only) Added options to display streaming metrics, including frame rate, network latency, and download bandwidth inside their WorkSpaces. Note Uniform Resource Identifier (URI) is not supported in this version. For more information, see Customize how users log in to their WorkSpaces • Improved client custom branding by storing assets in the same AWS Regions as provision ed WorkSpaces. • Resolved image auto-scaling issue with client custom branding logo files. • Fixed Japanese keyboard mapping issues. 4.6.0 June 21, 2023 Release notes 55 Amazon WorkSpaces Release 4.5.0 Date Changes December 27, 2022 • Resolved the issue of users being unable User Guide to disconnect from WorkSpaces when their network connectivity was lost or unavailab le. • Updated PCoIP SDK for the WorkSpaces Linux client. 4.4.0 October 27, 2022 Ubuntu 20.04 support. WorkSpaces macOS client application The following information helps you get started with the WorkSpaces macOS client application. Contents • Requirements • Setup and installation • Determine your client version • Connect to your WorkSpace • Manage your login information (3.0+ clients only) • Client views • Client language • Display support • Proxy servers • Command shortcuts • Remap the Windows logo key or the Command key • Disconnect • Clipboard support • Diagnostic log upload • Release notes macOS 56 Amazon WorkSpaces Requirements User Guide macOS version PCoIP DCV 12 (Monterey) and earlier Not supported Not supported 13 (Ventura) 14 (Sonoma) 15 (Sequoia) Note 4.0 or higher |
workspaces-ug-017 | workspaces-ug.pdf | 17 | you get started with the WorkSpaces macOS client application. Contents • Requirements • Setup and installation • Determine your client version • Connect to your WorkSpace • Manage your login information (3.0+ clients only) • Client views • Client language • Display support • Proxy servers • Command shortcuts • Remap the Windows logo key or the Command key • Disconnect • Clipboard support • Diagnostic log upload • Release notes macOS 56 Amazon WorkSpaces Requirements User Guide macOS version PCoIP DCV 12 (Monterey) and earlier Not supported Not supported 13 (Ventura) 14 (Sonoma) 15 (Sequoia) Note 4.0 or higher 5.5.0 or later 4.0 or higher 5.5.0 or later Not supported Supported If your WorkSpace is located in the Asia Pacific (Mumbai) Region, you must use version 3.1.3 or later of the Amazon WorkSpaces macOS client application. Setup and installation To download and install the client application, complete the following procedure. To download and install the client application 1. On your macOS device, open Amazon WorkSpaces Client Downloads and choose the MacOS X link. 2. Download and install the application. 3. Verify that the Amazon WorkSpaces client application icon appears on the desktop. If you're having trouble updating your WorkSpaces macOS client application to a newer version, use the following procedure to update your client application. To update the WorkSpaces macOS client application to a newer version 1. 2. In the Finder, open your Applications folder, then open Utilities, and choose Terminal. In the Terminal window, enter the following command, and then press the Return key. Requirements 57 Amazon WorkSpaces User Guide 3. 4. defaults delete com.amazon.workspaces SUSkippedVersion In the Terminal app, choose Terminal, Quit Terminal. If you have not already entered a registration code in the WorkSpaces macOS client application, do so, and then choose Amazon WorkSpaces, Quit Amazon WorkSpaces to close the client application. 5. Restart the WorkSpaces macOS 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. To connect to your WorkSpace for 3.0+ clients 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. Determine your client version 58 Amazon WorkSpaces User Guide 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 macOS 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. 2. 3. In the WorkSpaces client application, go to Settings, Manage Login Information. In the Manage Login Information dialog box, you can see the registration code and Region information for your WorkSpace. (Optional) If you want the WorkSpaces client to remember your current registration code, select the Remember Registration Code check box. 4. Under Saved registration |
workspaces-ug-018 | workspaces-ug.pdf | 18 | 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. 2. 3. In the WorkSpaces client application, go to Settings, Manage Login Information. In the Manage Login Information dialog box, you can see the registration code and Region information for your WorkSpace. (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 you want to name. 5. 6. In the WorkSpace name box, enter a name for the WorkSpace. (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. Manage your login information (3.0+ clients only) 59 Amazon WorkSpaces User Guide You can also toggle full screen mode by pressing Command+Option+Return. 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. 2. Enter your desired language in the Select a language list and choose Save. 3. Restart the client. Display support WorkSpaces Value, Standard, Performance, Power, PowerPro, 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. Displays 2 4 Client language Resolution 3840x2160 1920x1200 60 Amazon WorkSpaces Note User Guide • You can only extend the display. You cannot duplicate the display. Duplicating the display will cause your session to be disconnected. • Graphics bundles support only a single monitor configuration with a maximum resolution of 2560x1600. 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. Note If your screen resolution in WorkSpaces is low and objects look blurry, you need to turn on high DPI mode and adjust the display scaling settings on your Mac. For more information, 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 Connect one or more external displays with your Mac in the Apple 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 Command+Option+Ret urn. Display support 61 Amazon WorkSpaces User Guide 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 To use full screen mode on only some of the displays in a multiple monitor setup, press and hold the Option key and then click the green maximize button in the top-left corner of the WorkSpaces window. This button expands the WorkSpaces client window to full size on a screen without extending the WorkSpace to the other displays. To return to the previous window size, press and hold the Option key and click the maximize button again. 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 • The desktop streaming connections to the WorkSpace require ports 4172 and 4195 to be enabled, and do not go through the proxy server. • Proxy servers that require authentication with a sign-in credentials |
workspaces-ug-019 | workspaces-ug.pdf | 19 | displays. To return to the previous window size, press and hold the Option key and click the maximize button again. 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 • The desktop streaming connections to the WorkSpace require ports 4172 and 4195 to be enabled, and do not go through the proxy server. • Proxy servers that require authentication with a sign-in credentials are not supported. To use a proxy server for 3.0+ clients By default, the 3.0+ macOS 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. Proxy servers 62 Amazon WorkSpaces Note User Guide If you specify a custom proxy server, a "No network" error might appear when you attempt to log in to your WorkSpace. To work around this issue, use the default operating system proxy server instead of specifying a custom proxy server in the macOS client. 1. 2. In the WorkSpaces client application, go to Settings, Manage Proxy Server. In the Set Proxy dialog box, select Use proxy server, enter the proxy server URL or IP address and the port, and choose Save. Command shortcuts The WorkSpaces macOS client supports the following command shortcuts: If you're using... 3.0+ client Use these shortcuts Command+Q—Quit Amazon WorkSpaces Command+Option+Return—Toggle full screen display Command+Option+F12—Disconnect session Remap the Windows logo key or the Command key By default, the Windows logo key on a Windows keyboard and the Command key on an Apple keyboard are both mapped to the Ctrl key when you're using the Amazon WorkSpaces macOS client application. If you want to change this behavior so that these two keys are mapped to the Windows logo key for use with Windows WorkSpaces, use the following procedure. To map the Windows logo key or the Command key to the Windows logo key 1. If you haven't already done so, install or update to version 3.0.5 or later of the Amazon WorkSpaces macOS client application. 2. In the Finder, open your Applications folder, then open Utilities, and choose Terminal. Command shortcuts 63 Amazon WorkSpaces User Guide 3. In the Terminal window, enter the following command, and then press the Return key. defaults write "com.amazon.Amazon WorkSpaces Client" remap_cmd_to_ctrl 0 4. 5. In the Terminal app, choose Terminal, Quit Terminal. If your WorkSpaces macOS client application is running, choose Amazon WorkSpaces, Quit Amazon WorkSpaces in the client to close the client application. 6. Restart the WorkSpaces macOS client application and log in to your WorkSpace. The Windows logo key or the Command key should now be mapped to the Windows logo key. Disconnect To disconnect the macOS client application, you have several options: • In the Amazon WorkSpaces client application, go to Amazon WorkSpaces, and then choose Disconnect WorkSpace. Your WorkSpace session ends, but the client application continues running in case you want to log in again. • In the Amazon WorkSpaces client application, go to Amazon WorkSpaces, and then choose End Session. When ending the session, you'll be prompted to save open documents. Selecting End Session in the prompt will disconnect you from the WorkSpaces client user session. Note This option is available only for WorkSpaces Pools. • In the Amazon WorkSpaces client application, go to Amazon WorkSpaces, and then choose Quit Amazon WorkSpaces. Your WorkSpace session ends, and the client application closes. • In the Amazon WorkSpaces client application, close the WorkSpaces client window by clicking the red close (X) button in the upper-left corner. This disconnects the session and returns you to the application homepage. • You can also log off of the WorkSpace. In the Amazon WorkSpaces client application, go to View, and then choose Send Ctrl+Alt+Delete. Choose Sign Out. Your WorkSpace session ends, but the client application continues running in case you want to log in again. Disconnect 64 Amazon WorkSpaces Clipboard support User Guide The clipboard supports a maximum uncompressed object size of 20 MB. For more information, see the section called “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. Diagnostic log upload Enabling diagnostic log uploads To troubleshoot issues with the WorkSpaces client, you can enable diagnostic logging. The log files that are |
workspaces-ug-020 | workspaces-ug.pdf | 20 | support User Guide The clipboard supports a maximum uncompressed object size of 20 MB. For more information, see the section called “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. 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 Clipboard support 65 Amazon WorkSpaces User Guide 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 client application. Release 5.27.0 5.26.2 5.26.0 5.25.0 5.24.0 5.23.1 5.23.0 Release notes Date Changes April 30, 2025 • Updated the DCV SDK. • Updated the PCoIP SDK. • Bug fixes and enhancements. April 1, 2025 Bug fixes and enhancements. March 4, 2025 • Updated the DCV SDK. • Updated the .NET SDK. • Bug fixes and enhancements. December 19, 2024 Bug fixes and enhancements. November 22, 2024 • Added a progress bar to help users better understand the expected time during the loading of their WorkSpace. • Added a notification to warn idle users they will be disconnected from their DCV WorkSpaces due to inactivity. • Updated the DCV SDK. • Updated the RestSharp library. • Bug fixes and enhancements. October 17, 2024 Bug fixes and enhancements. September 30, 2024 • Renamed WSP protocol to Amazon DCV protocol. 66 Amazon WorkSpaces User Guide Release Date Changes • Added support for streaming over port 443 for TCP and UDP protocols on DCV WorkSpaces. • Updated the .NET SDK. • Bug fixes and enhancements. 5.22.1 5.22.0 5.21.0 5.20.0 September 3, 2024 Bug fixes and enhancements. August 16, 2024 Updated the DCV SDK. July 3, 2024 Bug fixes and enhancements. June 13, 2024 • Updated PCoIP SDK. 5.19.3 April 30, 2024 • Updated DCV SDK. • Migrated the software framework to .NET 8 LTS. • Updated system to require macOS 12 or later. Fixed issue where users get immediately disconnected from their DCV WorkSpaces when connecting to it. 5.19.0 February 28, 2024 • Added WebAuthn support for in-session authentication. • Resolved a white screen issue for DCV WorkSpaces. • Fixed the pixelation issue for DCV WorkSpaces. • Resolved crash issues for DCV WorkSpaces. • Updated DCV SDK. Release notes 67 Amazon WorkSpaces Release 5.18.0 Date Changes January 22, 2024 • Updated PCoIP SDK. User Guide • Updated DCV SDK. • Added support for macOS 14 (Sonoma). • Fixed keyboard issue where the first keystrokes were not being transmitted after unlocking the screen. 5.17.0 November 16, 2023 • Fixed a login issue due to a custom proxy error on macOS Ventura. • Added support to configure option key behavior on DCV client. • Fixed a client crash when users change running mode. • Fixed the screen freezing issue when using a Smart Card on DCV client. • Improve stability during resizes on DCV client. • Improved visual accessibility. 5.16.0 October 26, 2023 • Improved visual accessibility. 5.15.1 September 20, 2023 • Updated DCV SDK. • Enabled persistent Webcam connection after fast DCV WorkSpace reconnection. • Fixed connectivity issues on DCV WorkSpace s when using a proxy server. • Updated DCV SDK. • Bug fixes and enhancements. Release notes 68 Amazon WorkSpaces Release 5.12.0 Date Changes August 29, 2023 • Updated PCoIP SDK and DCV SDK. User Guide 5.11.0 June 29, 2023 5.10.0 June 19, 2023 5.9.0 May 9, 2023 • Resolved an login page special character processing issue. • Added a link to Amazon WorkSpaces user guide under the Support menu. Added options to enable or disable Ctrl + left-click as right-click and enable or disable mapping the Command key to the Ctrl key. To |
workspaces-ug-021 | workspaces-ug.pdf | 21 | Fixed connectivity issues on DCV WorkSpace s when using a proxy server. • Updated DCV SDK. • Bug fixes and enhancements. Release notes 68 Amazon WorkSpaces Release 5.12.0 Date Changes August 29, 2023 • Updated PCoIP SDK and DCV SDK. User Guide 5.11.0 June 29, 2023 5.10.0 June 19, 2023 5.9.0 May 9, 2023 • Resolved an login page special character processing issue. • Added a link to Amazon WorkSpaces user guide under the Support menu. Added options to enable or disable Ctrl + left-click as right-click and enable or disable mapping the Command key to the Ctrl key. To access both options, from the menu bar, choose Settings, Manage Modifier Keys. • Improved client custom branding by storing assets in the same AWS Regions as provision ed WorkSpaces. • Resolved black screen issue when using multiple monitors with Ubuntu WorkSpaces. • Fixed client diagnostic log uploading issues, where proxy settings were not being persisted when connecting to WorkSpaces through a proxy server. • Added support for DCV extension SDK, which allows end users to customize their DCV WorkSpaces experience. Updated DCV SDK to fix playback volume issues. Release notes 69 Amazon WorkSpaces Release 5.8.0 Date Changes April 6, 2023 • Added accessibility improvements. User Guide • Added support for automatic diagnostic log uploads feature, which allows you to upload WorkSpaces client log files directly to WorkSpaces to troubleshoot issues without interrupting the use of the WorkSpaces client. • Updated the DCV v2 SDK to fix InSession Latency reporting. 5.7.0 February 23, 2023 • Updated the DCV SDK. • Enabled trimming leading or trailing allow list in sign-in credentials. 5.6.0 December 27, 2022 • Added support for certificate-based authentication via SAML 2.0 integration, which removes the logon prompt for the Active Directory domain password. • Resolved the issue of the Workspace menu bar being inaccessible when maximizing the Workspace application window. • Updated PCoIP SDK for the WorkSpaces macOS client. 5.5.0 5.4.0 5.3.0 5.2.0 5.1.0 November 14, 2022 Updated the DCV client SDK. November 10, 2022 Added a shortcut Command+Alt+F12 to disconnect your WorkSpaces. September 15, 2022 Bug fixes and enhancements. August 24, 2022 Fixed WorkSpaces login issue when using Smart Card. June 30, 2022 Updated PCoIP SDK for MacOS. Release notes 70 Amazon WorkSpaces Release 4.0.7 Date Changes March 3, 2022 Fixed a WorkSpaces connection error caused by the Proxy settings on MacBook. User Guide 4.0.6 December 21, 2021 • Resolves crashes and black screen issues related to video streaming for DCV • Updates to DCV version 1.9.8.18175 4.0.5 November 23, 2021 • Optimizes the bandwidth and frame rates 4.0.4 November 3, 2021 for DCV WorkSpaces • Resolves the shortcut mapping issue related to full screen mode • Resolves the spinning wheel problem on the Login screen in macOS Big Sur with PCoIP WorkSpaces • Video streaming improvements for WorkSpaces that support DCV • Bug fixes 4.0.3 4.0.2 4.0.1 3.1.9 3.1.8 October 4, 2021 Bug fixes and enhancements. September 8, 2021 Minor bug fixes and enhancements. August 5, 2021 Minor bug fixes and enhancements. June 29, 2021 Minor bug fixes and enhancements. May 28, 2021 • Addresses a crash issue after disconnecting from PCoIP WorkSpaces • Addresses a connectivity issue with DCV WorkSpaces on M1 Mac hardware • Minor bug fixes and enhancements Release notes 71 Amazon WorkSpaces Release 3.1.7 Date Changes April 29, 2021 • Improves connectivity with WorkSpaces User Guide 3.1.6 3.1.5 April 8, 2021 April 2, 2021 using the DCV • Minor bug fixes and enhancements Fixes for disconnects and crashes resulting from DCV audio traffic optimization • Adds in-session and pre-session support for Common Access Card (CAC) and Personal Identity Verification (PIV) smart cards with DCV Windows WorkSpaces • Bidirectional video webcam support is now generally available for Windows WorkSpace s using the DCV • Minor bug fixes and enhancements 3.1.4 March 16, 2021 • Addresses a few crash scenarios when users register, log in, and rebuild • Adds localization support for more UI elements • Minor bug fixes and enhancements 3.1.3 February 15, 2021 • Adds support for mouse middle button 3.1.2 January 8, 2021 dragging • Minor bug fixes and enhancements • The DCV is now generally available. Video-in functionality continues to be available as a beta feature on DCV WorkSpaces only • Minor bug fixes and enhancements 3.1.0 December 1, 2020 Minor bug fixes and enhancements Release notes 72 Amazon WorkSpaces Release 3.0.12 Date Changes November 10, 2020 • Adds enhancements to the session User Guide reconnect experience • Improves error messaging during session disconnects for DCV WorkSpaces • Fixes keyboard mapping issue with the Shift key for DCV WorkSpaces • Fixes an issue in the device-enumeration logic where video-in devices might not be shown on subsequent logins for DCV WorkSpaces 3.0.11 October 02, 2020 • Resolves an intermittent crash issue when |
workspaces-ug-022 | workspaces-ug.pdf | 22 | available as a beta feature on DCV WorkSpaces only • Minor bug fixes and enhancements 3.1.0 December 1, 2020 Minor bug fixes and enhancements Release notes 72 Amazon WorkSpaces Release 3.0.12 Date Changes November 10, 2020 • Adds enhancements to the session User Guide reconnect experience • Improves error messaging during session disconnects for DCV WorkSpaces • Fixes keyboard mapping issue with the Shift key for DCV WorkSpaces • Fixes an issue in the device-enumeration logic where video-in devices might not be shown on subsequent logins for DCV WorkSpaces 3.0.11 October 02, 2020 • Resolves an intermittent crash issue when disconnecting from a DCV WorkSpace • Minor bug fixes and enhancements 3.0.10 September 16, 2020 Adds support for health checks over port 4195 (UDP and TCP) 3.0.9 3.0.8 August 14, 2020 Minor bug fixes and enhancements July 30, 2020 • For improved diagnostics, displays round trip time (RTT) as part of the network health check information • Minor bug fixes and enhancements 3.0.7 June 3, 2020 • Adds support for multiple monitors on DCV WorkSpaces • Minor bug fixes and enhancements 3.0.6 April 28, 2020 • Adds support for toggling between high DPI and standard DPI displays • Minor bug fixes and enhancements Release notes 73 Amazon WorkSpaces Release 3.0.5 Date Changes March 30, 2020 • Resolves an issue with the user interface User Guide displaying a login prompt if single sign-on (SSO) is enabled for Amazon WorkDocs • Adds support to map the Command key to the Windows logo key 3.0.4 March 3, 2020 • Adds support for connecting to DCV WorkSpaces • Minor bug fixes and enhancements 3.0.3 3.0.2 February 24, 2020 Improves readability on high DPI devices February 14, 2020 • Adds keyboard shortcut to toggle full screen display • Minor bug fixes and enhancements 3.0.0 November 25, 2019 • Improved user interface • Friendly registration code labels • Client-side GPU rendering • Minor bug fixes and enhancements 2.5.11 November 4, 2019 • Resolves issues with support for the macOS 2.5.9 2.5.8 2.5.7 Catalina keyboard • Minor bug fixes Minor bug fixes • Resolves an intermittent crashing issue related to computer waking up when opening a laptop lid • Adds support for German keyboard layouts with Linux WorkSpaces • Resolves an issue that results in a crash of Excel with clipboard direction Release notes 74 Amazon WorkSpaces User Guide Release Date 2.5.6 2.5.5 2.5.2 2.5.1 2.5.0 2.4.10 2.4.9 Changes Minor fixes • Resolves an issue with sub-optimal resolutio n with external displays in full-screen mode connected using USB-C • Minor bug fixes • Resolves an issue that results in crashes when multiple monitors are used and clients are connected to WorkSpaces running Amazon Linux 2 • Resolves an intermittent issue with the Caps lock key becoming stuck • Minor bug fixes • Resolves an issue that periodically results in repeated key presses with WorkSpaces running Amazon Linux 2 • Adds support for localized date and time formats in the user interface • Adds handling for URIs that end with an extra '/' • Minor user interface improvements Adds support for user self-service WorkSpace management capabilities Minor fixes Minor fixes Release notes 75 Amazon WorkSpaces Release 2.4.8 2.4.7 2.4.6 2.4.4 2.4.2 2.4.0 2.3.7 Date Changes User Guide • Adds support for uniform resource identifie rs (URIs), which enable login orchestration • Improves the behavior of function (Fn) keys on macOS • Improves protocol handling • Minor fixes • Adds support for time zone redirection for more Regions: America/Indianapol is America/Indiana/Marengo America/I ndiana/Vevay America/Indiana/Indianapolis • Includes text changes to the Login page user interface • Adds support for configuring the logging level to include advanced logging for debug scenarios • Minor improvements to session provision handling • Increases error handling for keyboard connections • Minor fixes • Improves copy and paste Minor fixes • New logo • Improves the user interface and stability • Addresses a gray screen issue that occurs when displays are in different orientations • Resolves a crashing issue on macOS Release notes 76 Amazon WorkSpaces User Guide Release Date Changes 2.3.6 2.3.5 2.3.3 2.3.1 2.3.0 2.2.3 2.2.1 2.1.4 2.1.3 2.1.0 Localization enhancements Minor improvements • Improves support for multiple monitors • Localization enhancements • Improves security and performance Minor fixes • Improves support for multiple monitors • Improves security and stability Resolves minor bugs and improves stability • Adds support for the German language • Resolves issues with time zone mapping for some Regions • Resolves a connection issue on Russian systems • Improves the Japanese user interface • Improves stability Resolves a crash issue on macOS Sierra Closing the client expires the reconnect token. You can easily reconnect to your WorkSpace as long as the client is running. • Adds support for the following new WorkSpace states: STOPPING and STOPPED • Resolves minor bugs |
workspaces-ug-023 | workspaces-ug.pdf | 23 | security and performance Minor fixes • Improves support for multiple monitors • Improves security and stability Resolves minor bugs and improves stability • Adds support for the German language • Resolves issues with time zone mapping for some Regions • Resolves a connection issue on Russian systems • Improves the Japanese user interface • Improves stability Resolves a crash issue on macOS Sierra Closing the client expires the reconnect token. You can easily reconnect to your WorkSpace as long as the client is running. • Adds support for the following new WorkSpace states: STOPPING and STOPPED • Resolves minor bugs and improves stability Release notes 77 Amazon WorkSpaces Release 2.0.8 2.0.4 1.1.80 Date Changes User Guide • Resolves an issue with out-of-app keyboard input passing to WorkSpaces • If Remember Me is disabled, the user name is not shown on restart • Adds a confirmation dialog box when deleting a registration code • Improves stability • Adds support for audio in, enabling you to make calls or attend web conferences • Adds support for devices with high DPI screens • Adds support for saving registration codes, enabling you to switch WorkSpaces without re-entering the registration codes • Improves support for OS X El Capitan • Improves usability and stability • Adds CloudWatch metrics for session latency, session launch time, and session disconnects • Improves auto session resume so that you are interrupted less frequently when network conditions are degraded • Resolves specific issues and improves stability Release notes 78 Amazon WorkSpaces Release 1.1.6 1.1.4 Date Changes User Guide • Adds support for status notifications. The client application notifies you about the state of your WorkSpace when it cannot connect to the WorkSpace. • Improves the reconnect experience. The client automatically redirects to the login screen after 10 hours of inactivity. You can reconnect again if the client fails to launch a session using reconnect. • Adds support for auto session resume. The client application automatically attempts to resume your session if network connectiv ity is lost and then regained within the session resume timeout (default value is 20 minutes). • Improves network health checks so they are faster and more reliable • Adds client-side validation of registration codes • Improves the synchronization of Caps Lock and Num Lock status between the local device and the WorkSpace • Adds support for saving your credentials, enabling you to easily reconnect to your WorkSpace • Improves advanced connection health checks • Improves stability Release notes 79 Amazon WorkSpaces Release 1.0.8 1.0 Date Changes User Guide • Introduces a full-file installation package • Improves network connectivity checks • Adds version information to the About window Initial release WorkSpaces PCoIP zero client You can set up and use a PCoIP zero client device with WorkSpaces. Requirements To use a PCoIP zero client with WorkSpaces, you need the following: • PCoIP zero clients are compatible only with WorkSpaces that are using the PCoIP protocol. • Your Tera2 zero client device must have firmware version 6.0.0 or later. If your Tera2 zero client device has a firmware version between 4.6.0 and 6.0.0, your WorkSpaces administrator must upgrade your device firmware through a Desktop Access subscription at https:// www.teradici.com/products/zero-clients#buy. • WorkSpaces multi-factor authentication (MFA) requires a Tera2 zero client device with firmware version 6.0.0 or later. • Your WorkSpaces administrator might need to enable your zero client device to use USB printers and other USB peripheral devices. If you're having trouble using a USB printer or other USB peripheral devices, contact your WorkSpaces administrator for assistance. For more information, see USB printers and other USB peripherals aren't working for PCoIP zero clients in the Amazon WorkSpaces Administration Guide. For a list of approved PCoIP zero client devices, see PCoIP Zero Clients on the Teradici website. Connect to your WorkSpace If your zero client device has firmware version 6.0.0 or later, you can connect to your WorkSpace. If your zero client device has a firmware version between 4.6.0 and 6.0.0, your WorkSpaces WorkSpaces PCoIP zero client 80 Amazon WorkSpaces User Guide administrator must upgrade your device firmware through a Desktop Access subscription at https://www.teradici.com/desktop-access. To connect to your WorkSpace 1. 2. 3. From the PCoIP zero client device, choose Options, Configuration, Session, and choose the OSD: WorkSpaces Session Settings connection type. Enter the registration code from your welcome email. Enter a name for this registered WorkSpace. 4. Choose Connect. Disconnect from the zero client To disconnect the zero client from your WorkSpace, you can press Ctrl+Alt+F12. Alternatively, you can log off of the WorkSpace, which disconnects the client. WorkSpaces Web Access Users can access their Windows WorkSpaces and DCV Linux WorkSpaces from any location using a web browser. This is ideal for users who access WorkSpaces from a personally-owned or locked- down device, because installing and maintaining a client |
workspaces-ug-024 | workspaces-ug.pdf | 24 | Options, Configuration, Session, and choose the OSD: WorkSpaces Session Settings connection type. Enter the registration code from your welcome email. Enter a name for this registered WorkSpace. 4. Choose Connect. Disconnect from the zero client To disconnect the zero client from your WorkSpace, you can press Ctrl+Alt+F12. Alternatively, you can log off of the WorkSpace, which disconnects the client. WorkSpaces Web Access Users can access their Windows WorkSpaces and DCV Linux WorkSpaces from any location using a web browser. This is ideal for users who access WorkSpaces from a personally-owned or locked- down device, because installing and maintaining a client application can be challenging. Instead of using a traditional remote access solution and installing the appropriate client application, users can visit the website to access their work resources. Limits • We strongly recommend using Web Access with DCV WorkSpaces for best streaming quality and user experience. The following are limitations when using Web Access with PCoIP WorkSpaces: • Web Access with PCoIP is not supported in the AWS GovCloud (US) Regions, Asia Pacific (Mumbai), Africa (Cape Town), and Israel (Tel Aviv) • Web Access with PCoIP is only supported for Windows WorkSpaces, not with Amazon Linux WorkSpaces. • Web Access is not available for some Windows 10 WorkSpaces that are using the PCoIP protocol. If your PCoIP WorkSpaces are powered by Windows Server 2019 or 2022, Web Access is not available. • You can't use a web browser to connect to GPU-enabled WorkSpaces. Disconnect from the zero client 81 Amazon WorkSpaces User Guide • If you are using macOS on VPN and using the Firefox web browser, the web browser will not support streaming PCoIP workspaces using WorkSpaces Web Access. This is due to a limitation in Firefox implementation of the WebRTC protocol. • As of October 1, 2020, you can't use the Amazon WorkSpaces Web Access client to connect to Windows 7 custom WorkSpaces or to Windows 7 Bring Your Own License (BYOL) WorkSpaces. Contents • Website • Requirements • Client views • Proxy servers • Features for WorkSpaces configured for DCV • Enabling diagnostic log uploads Website Open WorkSpaces Web Access to log on to your Windows WorkSpace through your web browser. If your WorkSpaces are in the AWS GovCloud (US) Regions, open WorkSpaces Web Access to connect to your WorkSpaces. Requirements You can access a WorkSpace by running the Windows 10 desktop experience and one of the following bundles: • Value • Standard • Performance • Power • PowerPro You must have web connectivity. Website 82 Amazon WorkSpaces Note User Guide You can connect to your DCV WorkSpaces using Web Access in the AWS GovCloud (US) Regions. Connecting to PCoIP WorkSpaces via Web Access is not supported in the AWS GovCloud (US) Regions. Your administrator must enable WorkSpaces Web Access. For more information, see Enable and Configure Amazon WorkSpaces Web Access in the Amazon WorkSpaces Administration Guide. WorkSpaces configured for PCoIP You must run one of the following web browsers on your Windows, macOS, or Linux computer: • Google Chrome 55 and later • Firefox 52 and later WorkSpaces configured for DCV You must run one of the following web browsers on your Windows, macOS, or Linux computer: • Microsoft Edge (latest three major versions) • Google Chrome (latest three major versions) • Mozilla Firefox (latest three major versions) • Apple Safari for macOS (latest three major versions) Client views WorkSpaces Web Access supports multiple screen resolutions. The minimum supported resolution is 960x720 pixels, and the maximum supported resolution is 2560x1600 pixels. Only WorkSpaces configured for DCV supports multiple monitors. For more information, see Using multiple screens. Proxy servers If you are required to use a proxy server to access the internet, you can configure your browser to use the proxy server. Client views 83 Amazon WorkSpaces Limits User Guide • Proxy with authentication is not currently supported. • Proxy server support for Web Access can vary by browser. Chrome (versions 55 and later) supports Web Access traffic routed through a web proxy, while the current Firefox does not. • WorkSpaces configured for DCV use the web browser's proxy configuration. Features for WorkSpaces configured for DCV The following features apply only to WorkSpaces configured for DCV. Copying and pasting You can use the web browser client to copy and paste text and images between your local computer and the WorkSpaces session. Use keyboard shortcuts and context (right-click) menu to copy and paste text and images on Google Chrome and Microsoft Edge. Mozilla Firefox and Apple Safari does not support copying and pasting images, and require using the clipboard dialog to copy and paste text. Using a webcam Webcam functionality is supported only on Chromium-based browsers, such as Google Chrome and Microsoft Edge. It isn't supported on Mozilla Firefox. The steps for selecting the camera to use are |
workspaces-ug-025 | workspaces-ug.pdf | 25 | and pasting You can use the web browser client to copy and paste text and images between your local computer and the WorkSpaces session. Use keyboard shortcuts and context (right-click) menu to copy and paste text and images on Google Chrome and Microsoft Edge. Mozilla Firefox and Apple Safari does not support copying and pasting images, and require using the clipboard dialog to copy and paste text. Using a webcam Webcam functionality is supported only on Chromium-based browsers, such as Google Chrome and Microsoft Edge. It isn't supported on Mozilla Firefox. The steps for selecting the camera to use are the same across all supported web browsers. To select the webcam to use 1. In the client, choose the Workspaces Name menu, and then choose Preferences. 2. Choose the Camera tab, and then select the camera to use. 3. Close the Preferences modal. Note the following: • The camera menu items appear only if an administrator has authorized the use of a webcam in the session. • Users can't change the webcam selection while the webcam is in use. Features for WorkSpaces configured for DCV 84 Amazon WorkSpaces Use a webcam in a session User Guide Choose the webcam button in the client as shown in the following example to enable or disable your webcam for use in a session. The webcam button appears on the toolbar only if you're authorized to use a webcam and at least one webcam is connected to your local computer. The following table shows different states of the webcam: Icon Description The webcam is disabled. Choose the button to enable the webcam. If you didn't previously select the webcam to use, the default webcam is used. The webcam is enabled, but it's not in use. Choose the button to disable the webcam. The webcam is in use by a remote application in the WorkSpaces session. Choose the icon to disable the webcam. Using multiple screens To use multiple screens, choose the multiscreen button in the client as shown in the following example. Multiple screens are supported with up to two monitors. 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 the WorkSpaces client automatically. Enabling diagnostic log uploads 85 Amazon WorkSpaces To send log files User Guide 1. Open your Amazon WorkSpaces Web Access client. 2. At the top of the WorkSpaces sign in page, choose Diagnostic logging. 3. 4. In the dialog box, ensure Diagnostic logging is enabled. (Optional) To generate debugging-level details and verbose performance data, choose Advanced logging. WorkSpaces Windows client application The following information will help you get started with the WorkSpaces Windows client application. Contents • Requirements • Setup and installation • Determine your client version • Connect to your WorkSpace • Manage your login information (3.0+ clients only) • Client views • Client language • Display support • Proxy servers • Command shortcuts • Disconnect • Clipboard support • Manage hardware acceleration • Diagnostic log upload • Release notes Windows 86 Amazon WorkSpaces Requirements User Guide • The 4.x client and higher versions require 64-bit Microsoft Windows 8.1, Windows 10, or Windows 11. • The 3.x client requires 32-bit Microsoft Windows 7, Windows 8, or Windows 10. • The client version 5.20.0 and higher versions require Windows 11 - Version 22000 or later or Windows 10 - Version 1607 or later. Note DCV 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 4.x client 3.x client Open Amazon WorkSpaces Client Downloads and find the WorkSpace s Windows client. Under Get the latest 64 bit client, choose the Download button. Open Previous Versions. Find the WorkSpaces Windows client version and choose the Download button. Open Amazon WorkSpaces Client Downloads and find the WorkSpace s 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: • Install just for you. If you choose this option and you share your local machine with other users, the WorkSpaces client application is available only to you. If other users on the machine also want to use the WorkSpaces client application, they must install the application for their own use. Requirements 87 Amazon WorkSpaces User Guide • Install for all users of this machine. If you choose this option, the WorkSpaces client application is available to anyone who logs on to the local machine, including those with Guest |
workspaces-ug-026 | workspaces-ug.pdf | 26 | choices for how to install the Amazon WorkSpaces Windows client application: • Install just for you. If you choose this option and you share your local machine with other users, the WorkSpaces client application is available only to you. If other users on the machine also want to use the WorkSpaces client application, they must install the application for their own use. Requirements 87 Amazon WorkSpaces User Guide • Install for all users of this machine. If you choose this option, the WorkSpaces client application is available to anyone who logs on to the local machine, including those with Guest accounts. 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. 2. Select Install driver for USB redirection to enable the USB redirection features (the default setting is not selected). Choose Install. You must have administrator privileges to install the driver. Setup and installation 88 Amazon WorkSpaces User Guide 3. To install the client with PCoIP USB redirection, enter and run the following command in an elevated command prompt. 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: Setup and installation 89 Amazon WorkSpaces User Guide 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. To connect to your WorkSpace for 3.0+ clients 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 Determine your client version 90 Amazon WorkSpaces User Guide 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 |
workspaces-ug-027 | workspaces-ug.pdf | 27 | easily while the client Determine your client version 90 Amazon WorkSpaces User Guide 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. 2. 3. In the WorkSpaces client application, go to Settings, Manage Login Information. In the Manage Login Information dialog box, you can see the registration code and Region information for your WorkSpace. (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. 6. In the WorkSpace name box, enter a name for the WorkSpace. (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. Manage your login information (3.0+ clients only) 91 Amazon WorkSpaces User Guide 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. 2. Enter your desired language in the Select a language list and choose Save. 3. Restart the client. 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. Displays 2 Client language Resolution 3840x2160 92 Amazon WorkSpaces Displays 4 Note User Guide Resolution 1920x1200 • You can only extend the display. You cannot duplicate the display. Duplicating the display will cause your session to be disconnected. • Graphics bundles support only a single monitor configuration with a maximum resolution of 2560x1600. 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. Display support 93 Amazon WorkSpaces Note User Guide 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 |
workspaces-ug-028 | workspaces-ug.pdf | 28 | 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. Display support 93 Amazon WorkSpaces Note User Guide 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 • The desktop streaming connections to the WorkSpace require ports 4172 and 4195 to be enabled, and do not go through the proxy server. • Proxy servers that require authentication with sign-in credentials are not supported. To control the proxy server for 3.0+ clients 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. Proxy servers 94 Amazon WorkSpaces User Guide 1. 2. In the WorkSpaces client application, go to Settings, Manage Proxy Server. In the Set Proxy dialog box, select the appropriate options, depending on which version of the 3.0+ client you have. • Windows client version 3.1.3 or later — To disable usage of a proxy server, select Don't use proxy server. If you select Don't use proxy server, no proxy server is used when you access the internet. To use a proxy server, choose one of the following options, and then choose Save: • Use your device operating system settings — This option uses the proxy server settings for your operating system. • Customize proxy server for WorkSpaces — Enter the URL or IP address and the port for your custom proxy server. • Windows client versions 3.0.12, 3.1.0, and 3.1.2 — To enable or disable usage of a proxy server, select or deselect Use proxy server. If you deselect Use proxy server, no proxy server is used when you access the internet. If you've selected Use proxy server, choose one of the following options, and then choose Save: • Use your device operating system settings — This option uses the proxy server settings for your operating system. • Customize proxy server for WorkSpaces — Enter the URL or IP address and the port for your custom proxy server. • Windows client version 3.0.11 or earlier — By default, these versions of the client use the proxy server specified in the device operating system settings. To use a custom proxy server, choose Use proxy server, enter the URL or IP address and the port for the proxy server, and then choose Save. Command shortcuts The WorkSpaces Windows client supports the following command shortcuts: • Ctrl+Alt+Enter—Toggle full screen display • Ctrl+Alt+F12—Disconnect session Command shortcuts 95 Amazon WorkSpaces Disconnect User Guide To disconnect the Windows client application, you have several options: • In the Amazon WorkSpaces client application, go to Amazon WorkSpaces, and then choose Disconnect WorkSpace. Your WorkSpace session ends, but the client application continues running in case you want to log in again. • In the Amazon WorkSpaces client application, go to Amazon WorkSpaces, and then choose End Session. When ending the session, you'll be prompted to save open documents. Selecting End Session in the prompt will disconnect you from the WorkSpaces client user session. Note This option is available only for WorkSpaces Pools. • In the Amazon WorkSpaces client application, go to Amazon WorkSpaces, and then choose Quit Amazon WorkSpaces. Your WorkSpace session ends, and the client application closes. • In the Amazon WorkSpaces client application, close the WorkSpaces client window by clicking the close (X) button in the upper-right corner. This disconnects the |
workspaces-ug-029 | workspaces-ug.pdf | 29 | the Amazon WorkSpaces client application, go to Amazon WorkSpaces, and then choose End Session. When ending the session, you'll be prompted to save open documents. Selecting End Session in the prompt will disconnect you from the WorkSpaces client user session. Note This option is available only for WorkSpaces Pools. • In the Amazon WorkSpaces client application, go to Amazon WorkSpaces, and then choose Quit Amazon WorkSpaces. Your WorkSpace session ends, and the client application closes. • In the Amazon WorkSpaces client application, close the WorkSpaces client window by clicking the close (X) button in the upper-right corner. This disconnects the session and returns you to the application homepage. • You can also log off of the WorkSpace. In the Amazon WorkSpaces client application, go to View, and then choose Send Ctrl+Alt+Delete. Choose Sign Out. Your WorkSpace session ends, but the client application continues running in case you want to log in again. Clipboard support The clipboard supports a maximum uncompressed object size of 20 MB. For more information, see the section called “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. Disconnect 96 Amazon WorkSpaces User Guide 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: • The screen might have flickering black boxes in some places. • The screen might not properly update on the WorkSpaces login page, or it might not properly update after you log in to your WorkSpace. You might see artifacts on the screen. • Your mouse clicks might not be lined up with the cursor position on the screen. To enable hardware acceleration in version 3.1.5 or later of the Windows client 1. Choose Settings, Manage Hardware Acceleration. 2. 3. In the Manage Hardware Acceleration dialog box, select Enable Hardware Acceleration for Amazon WorkSpaces, and then choose Save. For this change to take effect, choose Amazon WorkSpaces, Quit Amazon WorkSpaces to close the Windows client application. Manage hardware acceleration 97 Amazon WorkSpaces User Guide 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 2. Use the following command to add the EnableHwAcc registry key. reg add "HKCU\SOFTWARE\Amazon Web Services. LLC\Amazon WorkSpaces" /v EnableHwAcc This registry setting takes effect after the WorkSpaces Windows client is closed and restarted. 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. To disable hardware acceleration in version 3.1.5 or later of the Windows client 1. Choose Settings, Manage Hardware Acceleration. 2. 3. In the Manage Hardware Acceleration dialog box, unselect Enable Hardware Acceleration for Amazon WorkSpaces, and then choose Save. 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. Manage hardware acceleration 98 Amazon WorkSpaces User Guide To enable hardware acceleration in version 3.1.4 of the Windows client 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 |
workspaces-ug-030 | workspaces-ug.pdf | 30 | 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. Manage hardware acceleration 98 Amazon WorkSpaces User Guide To enable hardware acceleration in version 3.1.4 of the Windows client 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 Select Amazon WorkSpaces, and then choose Edit > New > String Value. For the registry key name, enter EnableHwAcc. 4. 5. 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 2. Use the following command to add the EnableHwAcc registry key. reg add "HKCU\SOFTWARE\Amazon Web Services. LLC\Amazon WorkSpaces" /v EnableHwAcc This registry setting takes effect after the WorkSpaces Windows client is closed and restarted. 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 Manage hardware acceleration 99 Amazon WorkSpaces User Guide This registry setting takes effect after the WorkSpaces Windows client is closed and restarted. To disable hardware acceleration in version 3.1.3 or earlier of the Windows client 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: • • 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. If the DisableHWAcceleration registry key doesn't exist, do the following: a. b. c. d. Select Avalon.Graphics, and then choose Edit > New > DWORD (32-bit) Value. For the registry key name, enter DisableHWAcceleration. Select the new DisableHWAcceleration key, and then choose Edit > Modify. In the Value data box, enter 1 (to disable hardware acceleration), set Base to Hexadecimal, and then choose OK. 5. Close the Registry Editor. 6. Close and restart the WorkSpaces client application. Note If you need to enable hardware acceleration to improve the performance of other Windows applications, set the DisableHWAcceleration key to 0. Manage hardware acceleration 100 Amazon WorkSpaces Diagnostic log upload Enabling diagnostic log uploads User Guide 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 |
workspaces-ug-031 | workspaces-ug.pdf | 31 | 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. Diagnostic log upload 101 Amazon WorkSpaces User Guide Release 5.27.0 5.26.2 5.26.1 5.26.0 Date Changes April 30, 2025 • Added support for extending full-screen across a selection of available connected monitors for Amazon DCV WorkSpaces. • Updated the DCV SDK. • Updated the PCoIP SDK. • Bug fixes and enhancements. April 1, 2025 Bug fixes and enhancements. March 11, 2025 Bug fixes and enhancements. March 4, 2025 • Added a Ctrl+Alt+DownArrow keyboard shortcut to help users navigate from the client application to their local operating system. • Updated the DCV SDK. • Updated the WebView2 SDK. • Updated the .NET SDK. • Bug fixes and enhancements. 5.25.0 December 19, 2024 • Added a progress bar to help users better understand the expected time during the loading of their WorkSpace. • Updated the DCV SDK. • Bug fixes and enhancements. 5.24.1 November 22, 2024 • Added a notification to warn idle users they will be disconnected from their DCV WorkSpaces due to inactivity. • Improved WorkSpaces client installation process. • Updated the DCV SDK. • Updated WolfSSL for PCoIP SDK. Release notes 102 Amazon WorkSpaces User Guide Release Date Changes • Updated the RestSharp library. • Bug fixes and enhancements. 5.23.0 September 30, 2024 • Renamed WSP protocol to Amazon DCV protocol. • Added support for file upload and download on DCV WorkSpaces. • Added support for streaming over port 443 for TCP and UDP protocols on DCV WorkSpaces. • Updated the .NET SDK. • Bug fixes and enhancements. 5.22.1 5.22.0 5.21.0 5.20.0 September 3, 2024 Bug fixes and enhancements. August 16, 2024 • Added support to persist webcam and microphone settings for future sessions on DCV WorkSpaces. • Updated the DCV SDK. July 3, 2024 Bug fixes and enhancements. June 13, 2024 • Updated PCoIP SDK. • Updated DCV SDK. • Migrated the software framework to .NET 8 LTS. • Updated system to require Windows 11 - Version 22000 or later and Windows 10 - Version 1607 or later. Release notes 103 Amazon WorkSpaces Release 5.19.3 Date Changes April 30, 2024 • Updated DCV SDK. User Guide • Fixed issue where white screens appear in all displays when using multiple monitors with WorkSpaces and clicking full screen. • Fixed issue where users get immediately disconnected from their DCV WorkSpaces when connecting to it. • Fixed issue where the device dialog box isn't showing correct localized language when switching languages. 5.19.0 February 28, 2024 • Updated DCV SDK. • Added WebAuthn support for in-session authentication. 5.18.0 5.17.0 January 22, 2024 Updated DCV SDK. November 16, 2023 • Fixed USB redirection issue for PCoIP WorkSpaces. • Fixed a client crash when users change running mode. • Fixed a client crash related to printer redirection on DCV client. • Bug fixes and enhancements. 5.16.0 October 26, 2023 • Added installation guidance. Users on 4.0.6+ version clients with USB redirection enabled need to uninstall old client before upgrading • Added restrictions that only admins have permission to modify custom installation folder • Updated DCV SDK Release notes 104 Amazon WorkSpaces Release 5.15.1 Date Changes September 20, 2023 • Added resiliency for network issues for DCV User Guide WorkSpaces • Updated DCV SDK • Bug fixes and enhancements 5.13.0 August 29, 2023 • Updated PCoIP SDK and DCV SDK • Resolved an login page special character processing issue • Resolved a crashing issue when closing the Network dialog on the upper right of the client application • Added a link to Amazon WorkSpaces user guide under the Support menu 5.12.1 5.12.0 5.11.0 August 16, 2023 Bug fixes and enhancements July 11, 2023 Bug fixes and enhancements July 3, 2023 • Bug fixes and enhancements • Added Ctrl+Alt+Shift+F11 as a keyboard shortcut to access the client menu during a streaming session • Fixed the issue where the text was getting cut off on the client login page when the operating system text size was set to 200% • Fixed a bug where the keyboard focus in the dialog box did not |
workspaces-ug-032 | workspaces-ug.pdf | 32 | upper right of the client application • Added a link to Amazon WorkSpaces user guide under the Support menu 5.12.1 5.12.0 5.11.0 August 16, 2023 Bug fixes and enhancements July 11, 2023 Bug fixes and enhancements July 3, 2023 • Bug fixes and enhancements • Added Ctrl+Alt+Shift+F11 as a keyboard shortcut to access the client menu during a streaming session • Fixed the issue where the text was getting cut off on the client login page when the operating system text size was set to 200% • Fixed a bug where the keyboard focus in the dialog box did not cycle through all the device selections when multiple devices were available for redirection. • Incrementally enhanced accessibility to color contrast and names for elements. Release notes 105 Amazon WorkSpaces Release 5.10.0 Date Changes June 19, 2023 • Improved client custom branding by storing assets in the same AWS Regions as provision User Guide 5.9.0 May 9, 2023 ed WorkSpaces • Resolved black screen issue when using multiple monitors with Ubuntu WorkSpaces • Fixed client diagnostic log uploading issues, where proxy settings were not being persisted when connecting to WorkSpaces through a proxy server • Added support for DCV extension SDK, which allows end users to customize their DCV WorkSpaces experience • Resolved the issue of displaying the Keep me logged in option in the Manage Login Information dialog when logging into WorkSpaces with SAML credentials • Resolved the issue of users not being able to log into WorkSpaces when proxy server is enabled • Resolved a keyboard focusing issue when navigating menu items using the Tab key • Updated DCV SDK to fix connectivity issues when using QUIC on DCV WorkSpaces 5.8.0 April 6, 2023 • Fixed a bug that prevented users from logging in under certain scenarios • Fixed a bug to bring certificate selection dialog to the front during smart card logon • Updated DCV v2 SDK to fix minor bugs Release notes 106 Amazon WorkSpaces Release 5.7.0 Date Changes February 23, 2023 • Enabled trimming leading or trailing allow User Guide list in sign-in credentials • Resolved a crashing issue due to empty registration code • Provided sufficient color contrast, text labels, and instructions in user interface components, such as a login page and a menu bar. 5.6.4 5.6.2 5.6.0 February 1, 2023 • Fixed sign-in credential validation issue • Fixed caps lock flicker issue January 18, 2023 Bug fixes and enhancements December 27, 2022 • Added support for certificate-based authentication via SAML 2.0 integration, which removes the logon prompt for the Active Directory domain password • Resolved an issue of the Alt key getting continuously pressed in WorkSpaces • Resolved an issue of the Num Lock state that was inverted between WorkSpaces and local machine • Updated PCoIP SDK for the WorkSpaces Windows client • Bug fixes and enhancements 5.5.0 November 14, 2022 • Added a shortcut Ctrl+Alt+F12 to disconnec t your WorkSpace • Resolved a keystroke-invoking issue when using Alt key with mouse clicks Release notes 107 Amazon WorkSpaces Release 5.4.0 User Guide Date Changes October 5, 2022 Added support for automatic diagnosti c 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. 5.3.0 September 15, 2022 • Updated DCV SDK for Windows • Resolved an issue of the WorkSpaces clients not being able to save their user names after closing their WorkSpace 5.2.1 5.2.0 5.1.0 5.0.0 August 24, 2022 Fixed the WorkSpaces login page rendering issues on Windows 8.1 August 2, 2022 Updated PCoIP SDK for the WorkSpaces Windows client June 30, 2022 Updated DCV SDK for Windows June 2, 2022 • Updated PCoIP SDK for the WorkSpaces 4.0.6 December 21, 2021 Windows client • Resolved issues when screen sharing WorkSpaces in Microsoft Teams • Bug fixes and enhancements • Enhances PCoIP USB redirection driver. The driver includes important updates and we recommend that all users install it • Resolves failures when using smart cards for authentication for DCV • Resolves crashes and black screen issues related to video streaming for DCV • Updates to DCV version 1.9.8.18175 Release notes 108 Amazon WorkSpaces Release 4.0.5 Date Changes November 23, 2021 • Optimizes the bandwidth and frame rates User Guide 4.0.4 November 3, 2021 4.0.3 October 4, 2021 for DCV WorkSpaces • Resolves the shortcut mapping issue related to full screen mode • Resolves the issue of the Alt key being pressed automatically • Resolves the issue of users not being able to switch between Korean and English languages using the Alt key on a physical keyboard • Resolves the mouse scrolling issue that is related to the mouse settings in Windows 10 • Video streaming improvements for WorkSpaces that support DCV • Bug fixes • Resolves crashes due |
workspaces-ug-033 | workspaces-ug.pdf | 33 | 23, 2021 • Optimizes the bandwidth and frame rates User Guide 4.0.4 November 3, 2021 4.0.3 October 4, 2021 for DCV WorkSpaces • Resolves the shortcut mapping issue related to full screen mode • Resolves the issue of the Alt key being pressed automatically • Resolves the issue of users not being able to switch between Korean and English languages using the Alt key on a physical keyboard • Resolves the mouse scrolling issue that is related to the mouse settings in Windows 10 • Video streaming improvements for WorkSpaces that support DCV • Bug fixes • Resolves crashes due to double-byte user names (for example, Japanese characters) on local machines • Resolves mouse-scrolling issues on 64-bit Windows 8.1 • Bug fixes and enhancements Release notes 109 Amazon WorkSpaces Release 4.0.2 Date Changes September 1, 2021 • Minor bug fixes and enhancements User Guide 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. • Adds USB redirection support for YubiKey U2F authentication on PCoIP Windows WorkSpaces • Minor bug fixes and enhancements The first 64-bit release of the Windows client application 4.0.1 July 30, 2021 4.0.0 June 30, 2021 3.1.10 3.1.9 August 5, 2021 Minor bug fixes and enhancements June 29, 2021 • This release includes fixes to custom login workflows with a URI and is recommended 3.1.8 May 28, 2021 for all users • Bug fixes and enhancements • Fixes the reconnect page redirection after disconnection when Keep me logged in is selected • Minor bug fixes and enhancements Release notes 110 Amazon WorkSpaces Release 3.1.7 Date Changes April 29, 2021 • Improves connectivity with WorkSpaces User Guide using the DCV • Resolves a crash issue related to proxy servers • Minor bug fixes and enhancements 3.1.6 3.1.5 April 8, 2021 Fixes for disconnects and crashes resulting from DCV audio traffic optimization April 2, 2021 • Adds Settings UI to enable/disable 3.1.4 March 16, 2021 hardware acceleration • Bidirectional video web cam support is now generally available for Windows WorkSpace s using the DCV • Minor bug fixes and enhancements • Disables hardware acceleration by default to address screen flickering and mouse mispositioning issues observed with certain display driver versions. To manually turn on hardware acceleration, users can restart the WorkSpaces app after creating a registry string value of EnableHwAcc under HKEY_CURRENT_USER\SOFTWARE \Amazon Web Services. LLC\Amazon WorkSpaces. • Addresses a few crash scenarios when users register, log in, and rebuild • Adds localization support for more UI elements • Minor bug fixes and enhancements Release notes 111 Amazon WorkSpaces Release 3.1.3 Date Changes February 15, 2021 • Fixes issue with double Shift key presses not User Guide 3.1.2 January 8, 2021 working in some apps • Improves settings UI for proxy configura tions • Minor bug fixes and enhancements • The DCV is now generally available. Video-in functionality continues to be available as a beta feature on DCV WorkSpaces only • Fixes an intermittent issue that impacts client application upgrades • Fixes an issue with the login screen being magnified • Minor bug fixes and enhancements 3.1.1 December 1, 2020 • Adds support for smart card authentication in the AWS GovCloud (US-West) Region • Minor bug fixes and enhancements Note Version 3.1.1 is available only in the AWS GovCloud (US-West) Region 3.1.0 December 1, 2020 • Resolves intermittent flickering issue inside of an active WorkSpaces session • Minor bug fixes and enhancements Release notes 112 Amazon WorkSpaces Release 3.0.12 Date Changes November 10, 2020 • Adds support for optionally disabling the User Guide 3.0.11 October 02, 2020 use of the default proxy server • Adds enhancements to the session reconnect experience • Improves error messaging during session disconnects for DCV WorkSpaces • Fixes keyboard mapping issue with the Shift key for DCV WorkSpaces • Resolves an issue with enumeration of video-in devices on DCV WorkSpaces • Resolves an intermittent crash issue when disconnecting from a DCV WorkSpace • Minor bug fixes and enhancements 3.0.10 September 16, 2020 • Resolves an issue with loading the login screen • Resolves an issue with persisting a user's screen size preference when the user chooses full screen mode and then exits this mode • Resolves an issue that causes the menu bar to be hidden after a user exits full screen mode • Resolves an input method editor (IME) issue • Adds support for health checks over port 4195 (UDP and TCP) 3.0.9 August 14, 2020 Minor bug fixes and enhancements Release notes 113 Amazon WorkSpaces Release 3.0.8 Date Changes July 30, 2020 • Adds monochrome cursor support on DCV User |
workspaces-ug-034 | workspaces-ug.pdf | 34 | • Resolves an issue with loading the login screen • Resolves an issue with persisting a user's screen size preference when the user chooses full screen mode and then exits this mode • Resolves an issue that causes the menu bar to be hidden after a user exits full screen mode • Resolves an input method editor (IME) issue • Adds support for health checks over port 4195 (UDP and TCP) 3.0.9 August 14, 2020 Minor bug fixes and enhancements Release notes 113 Amazon WorkSpaces Release 3.0.8 Date Changes July 30, 2020 • Adds monochrome cursor support on DCV User Guide WorkSpaces • For improved diagnostics, displays round trip time (RTT) as part of the network health check information • Minor bug fixes and enhancements 3.0.7 June 3, 2020 • Adds support for multiple monitors on DCV WorkSpaces • Minor bug fixes and enhancements 3.0.6 April 28, 2020 • Adds support for toggling between high DPI 3.0.5 March 30, 2020 and standard DPI displays • Minor bug fixes and enhancements Resolves an issue with the user interface displaying a login prompt if single sign-on (SSO) is enabled for Amazon WorkDocs 3.0.4 3.0.2 March 3, 2020 Minor bug fixes and enhancements February 14, 2020 • Adds keyboard shortcut to toggle full screen display • Adds support for connecting to DCV WorkSpaces • Minor bug fixes and enhancements 3.0.0 November 25, 2019 • Improved user interface • Friendly registration code labels • Minor bug fixes and enhancements 2.5.11 November 4, 2019 Minor bug fixes Release notes 114 Amazon WorkSpaces Release 2.5.10 2.5.9 2.5.8 2.5.7 2.5.6 2.5.5 2.5.2 2.5.1 Date Changes User Guide • Resolves an intermittent issue related to invalid keystrokes sent when closing a laptop lid • Minor fixes • Resolves the issue of displaying a blank app icon image on the Windows 10 task bar after WorkSpace client upgrades • Minor bug fixes Resolves an intermittent crashing issue related to computer waking up when opening a laptop lid • Adds support for German keyboard layouts with Linux WorkSpaces • Resolves an issue that results in a crash of Excel with clipboard direction Minor fixes Minor fixes • Resolves an intermittent issue with the Caps Lock key becoming stuck • Minor bug fixes • Resolves an issue that periodically results in repeated key presses with WorkSpaces running Amazon Linux 2 • Adds support for localized date and time formats in the user interface • Minor user interface improvements Release notes 115 Amazon WorkSpaces User Guide Release 2.5.0 2.4.10 2.4.9 2.4.8 2.4.7 2.4.6 Date Changes Adds support for user self-service WorkSpace management capabilities Minor fixes Minor fixes • Adds support for uniform resource identifie rs (URIs), which enable login orchestration • Minor fixes • Resolves an issue with the user interface text not displaying correctly on Microsoft Surface Pro 4 models (Windows only) • Adds support for time zone redirection for more Regions: America/Indianapol is America/Indiana/Marengo America/I ndiana/Vevay America/Indiana/Indianapolis • Includes user interface text changes for the Login page • Adds support for configuring the logging level to include advanced logging for debug scenarios • Minor improvements to session provision handling Release notes 116 Amazon WorkSpaces Release 2.4.5 2.4.4 2.4.2 2.4.0 2.3.7 2.3.6 2.3.5 2.3.3 2.3.2 2.3.1 Date Changes User Guide Adds a check to ensure that certificates issued by Amazon Trust Services are trusted by Windows during installation. By default, an up-to-date Windows local Root CA list includes Starfield Service Root Certificate Authority - G2, and therefore trusts Amazon Trust Services certificates. If the local Root CA list is outdated, the client installer installs the Starfield Service Root Certificate Authority - G2 certificate to the system. If you do not have administrator access to the client device, you'll be prompted to confirm the installation of the Root CA certificate. • Minor fixes • Improves copy and paste Minor fixes • New logo • Improves the user interface and stability Addresses a gray screen issue that occurs when displays are in different orientations Localization enhancements Minor improvements • Improves the support for multiple monitors • Localization enhancements • Improves security and performance Installer fixes Minor fixes Release notes 117 Amazon WorkSpaces User Guide Release 2.3.0 2.2.3 2.2.1 2.1.3 2.1.1 2.1.0 Date Changes • Improves support for multiple monitors • Improves security and stability Resolves minor bugs and improves stability • Adds support for the German language • Resolves time zone mapping issues for some Regions • Resolves a connection issue on Russian systems • Improves the Japanese user interface • Improves stability Closing the client expires the reconnect token. You can easily reconnect to your WorkSpace as long as the client is running. Minor improvement to protocol handling • Adds support for the following new WorkSpace states: STOPPING and STOPPED • Resolves minor bugs and improves stability Release notes 118 Amazon WorkSpaces |
workspaces-ug-035 | workspaces-ug.pdf | 35 | • Improves support for multiple monitors • Improves security and stability Resolves minor bugs and improves stability • Adds support for the German language • Resolves time zone mapping issues for some Regions • Resolves a connection issue on Russian systems • Improves the Japanese user interface • Improves stability Closing the client expires the reconnect token. You can easily reconnect to your WorkSpace as long as the client is running. Minor improvement to protocol handling • Adds support for the following new WorkSpace states: STOPPING and STOPPED • Resolves minor bugs and improves stability Release notes 118 Amazon WorkSpaces Release 2.0.8 2.0.6 2.0.4 Date Changes User Guide • Resolves a conflict with running iTunes or Garmin processes during installation • Adds support for a password-free installat ion experience if installing only for the current user • Resolves an issue with Excel formatting when copying and pasting data in BIFF5 format • If Remember Me is disabled, the user name is not shown on restart • Adds a confirmation dialog box when deleting a registration code • Improves stability Resolves bugs and includes other improveme nts • Adds support for audio in, enabling you to make calls or attend web conferences • Adds support for devices with high DPI screens • Adds support for saving registration codes, enabling you to switch WorkSpaces without re-entering the registration codes • Improves support for Windows 10 • Improves usability and stability Release notes 119 Amazon WorkSpaces Release 1.1.80 1.1.6 Date Changes User Guide • Adds CloudWatch metrics for session latency, session launch time, and session disconnects • Improves auto-session resume so that you are interrupted less frequently when network conditions are degraded • Resolves specific issues and improves stability • Adds support for status notifications. The client application notifies you about the state of your WorkSpace when it cannot connect to the WorkSpace. • Improves the reconnect experience. The client automatically redirects to the login screen after 10 hours of inactivity. You can reconnect again if the client fails to launch a session using reconnect. • Adds support for auto-session resume. The client application automatically attempts to resume your session if network connectiv ity is lost and then regained within the session-resume timeout (default value is 20 minutes). • Improves network health checks so they are faster and more reliable • Adds client-side validation of registration codes • Improves the synchronization of Caps Lock and Num Lock status between the local device and the WorkSpace Release notes 120 Amazon WorkSpaces Release 1.1.4 1.0.8 1.0 Date Changes User Guide • Adds support for saving your credentials, enabling you to easily reconnect to your WorkSpace • Improves advanced connection-health checks • Improves stability • Introduces a full-file installation package • Improves network connectivity checks • Adds version information to the About window Initial release Release notes 121 Amazon WorkSpaces User Guide Restarting a WorkSpace If you are experiencing issues with your WorkSpace, you can restart (reboot) it. Restarting a WorkSpace disconnects you from your WorkSpace, so that it can be shut down and restarted. Your user data, operating system, and system settings are not affected. This process takes several minutes to finish. Important To avoid losing changes, save any open documents and other application files before you restart your WorkSpace. To restart your WorkSpace 1. Open your WorkSpaces client and connect to your WorkSpace. 2. Choose WorkSpaces, Restart WorkSpace. 3. When prompted to restart your WorkSpace, choose Restart. 4. After you are disconnected from your WorkSpace, the client application login screen remains open. You can log back in to your WorkSpace, or close the screen. 122 Amazon WorkSpaces User Guide Rebuilding a WorkSpace To restore the operating system that is running on your WorkSpace to its original state, you can rebuild the WorkSpace. If you want to rebuild your WorkSpace to resolve an issue that you are experiencing with the WorkSpace, try restarting it first. If you rebuild your WorkSpace, any applications that you installed and system settings that you configured after the WorkSpace was created are lost. When a WorkSpace is rebuilt, the D: drive is re-created from the latest backup. Because backups are completed every 12 hours, your data might be up to 12 hours old. If your administrator recently created your WorkSpace, you must wait 12 hours before you can rebuild your WorkSpace. Important To avoid losing any data, save any open documents and other application files before you rebuild your WorkSpace, and then contact your WorkSpaces administrator to make sure your D: drive has been backed up. While your WorkSpace rebuild is in progress, you are disconnected from the WorkSpace. During this time, you can't use or make changes to the WorkSpace. The rebuild process might take up to an hour. To rebuild your WorkSpace 1. Open your WorkSpaces client and |
workspaces-ug-036 | workspaces-ug.pdf | 36 | 12 hours old. If your administrator recently created your WorkSpace, you must wait 12 hours before you can rebuild your WorkSpace. Important To avoid losing any data, save any open documents and other application files before you rebuild your WorkSpace, and then contact your WorkSpaces administrator to make sure your D: drive has been backed up. While your WorkSpace rebuild is in progress, you are disconnected from the WorkSpace. During this time, you can't use or make changes to the WorkSpace. The rebuild process might take up to an hour. To rebuild your WorkSpace 1. Open your WorkSpaces client and connect to your WorkSpace. 2. Depending on which client you're using, do one of the following. If you're using... Do this 3.0+ client 1.0+ or 2.0+ client Choose Settings, Rebuild WorkSpace. Choose My WorkSpace, Rebuild WorkSpace . 3. In the Rebuild WorkSpace dialog box, review the information. If you choose to proceed with the rebuild, choose Rebuild. 123 Amazon WorkSpaces User Guide Increasing WorkSpace disk size You can increase your WorkSpace disk size to add more storage capacity. You can increase the size of your C: drive (for Linux, this is /) up to 175 GB, and you can increase the size of your D: drive (for Linux, this is /home) up to 100 GB without contacting your administrator. If you need your drives increased beyond these limits, your administrator must increase the sizes of your drives for you. If your administrator recently created your WorkSpace, you must wait 6 hours before you can increase your WorkSpace disk sizes. After that, you can increase your disk sizes once in a 6-hour period. You cannot increase the size of the C: and D: drives at the same time. (The same is true of the / and /home volumes in Linux.) To increase the C: drive (or / in Linux), you must first increase the D: drive (or /home in Linux) to 100 GB. After the D: drive (or /home in Linux) has been increased, you can increase the C: drive (or / in Linux). While your WorkSpace disk size increase is in progress, you can perform most tasks on your WorkSpace. However, you can't change your WorkSpace compute type, switch the WorkSpace running mode, rebuild your WorkSpace, or restart your WorkSpace. The disk size increase process might take up to an hour. Important • You can resize only SSD volumes. • Increasing your WorkSpace disk size will increase the amount that your organization pays for your WorkSpace. To increase your WorkSpace disk size 1. Open your WorkSpaces client and connect to your WorkSpace. 2. Depending on which client you're using, do one of the following. If you're using... Do this 3.0+ client Choose Settings, Increase Disk Size. 124 Amazon WorkSpaces User Guide If you're using... 1.0+ or 2.0+ client Do this Choose My WorkSpace, Increase disk size. 3. The Increase disk size dialog box displays the current disk size of your C: drive and D: drive (or / and /home in Linux). If you proceed with the disk size increase, it also displays the amount by which your storage increases. 4. To proceed with the disk size increase, choose Increase. 5. A message displays information about the disk size increase process. Review the information, and choose Close. 6. When the disk size increase is finished, you must restart the WorkSpace for the changes to take effect. Save any open files before restarting the WorkSpace. 125 Amazon WorkSpaces User Guide Changing compute type for WorkSpaces You can change your WorkSpace compute type to choose a different bundle for your WorkSpace. If your administrator recently created your WorkSpace, you must wait 6 hours before you can change your WorkSpace compute type. After that, you can switch to a larger compute type once in a 6- hour period, or to a smaller compute type once in a 30-day period. When your WorkSpace compute type change is in progress, you are disconnected from the WorkSpace. During this time, you can't use or make changes to the WorkSpace. This process might take up to an hour. Important • To avoid losing changes, save any open documents and other application files before you change your WorkSpace compute type. • Changing your WorkSpace compute type will change the amount that your organization pays for your WorkSpace. To change your WorkSpace compute type 1. Open your WorkSpaces client and connect to your WorkSpace. 2. Depending on which client you're using, do one of the following. If you're using... Do this 3.0+ client 1.0+ or 2.0+ client Choose Settings, Change Compute Type. Choose My WorkSpace, Change compute type. 3. The Change compute type dialog box displays the current compute type for your WorkSpace. Choose a different compute type from the list, and then choose Update. 4. A message displays information |
workspaces-ug-037 | workspaces-ug.pdf | 37 | type. • Changing your WorkSpace compute type will change the amount that your organization pays for your WorkSpace. To change your WorkSpace compute type 1. Open your WorkSpaces client and connect to your WorkSpace. 2. Depending on which client you're using, do one of the following. If you're using... Do this 3.0+ client 1.0+ or 2.0+ client Choose Settings, Change Compute Type. Choose My WorkSpace, Change compute type. 3. The Change compute type dialog box displays the current compute type for your WorkSpace. Choose a different compute type from the list, and then choose Update. 4. A message displays information about the compute type change process. Review the information, and choose Update. 126 Amazon WorkSpaces User Guide Switching running mode for a WorkSpace You can specify whether your WorkSpace is always running or whether it stops after a specified period of inactivity. WorkSpaces provides the following two running modes that you can choose from. • AlwaysOn — Keeps your WorkSpace always running. • AutoStop — Your WorkSpace starts when you sign in and stops after a specified period of inactivity. After your WorkSpace stops, the state of your apps and data is saved. Note Switching your WorkSpace running mode will change the amount that your organization pays for your WorkSpace. To switch your WorkSpace running mode for 3.0+ clients 1. Open your WorkSpaces client and connect to your WorkSpace. 2. Choose Settings, Switch Running Mode. 3. In the Switch Running Mode dialog box, choose a different running mode, and then choose Switch. 4. A message confirms your choice. Close the message box. To switch your WorkSpace running mode for 1.0+ and 2.0+ clients 1. Open your WorkSpaces client and connect to your WorkSpace. 2. Choose My WorkSpace, Switch running mode. 3. In the Switch running mode dialog box, choose a different running mode, and then choose Switch. 4. A message confirms your choice. Choose Close. To switch your WorkSpace running mode for 3.0+ clients 127 Amazon WorkSpaces User Guide Peripheral device support for WorkSpaces client applications The Amazon WorkSpaces client applications offer the following support for peripheral devices. If you have an issue with using a particular device, have your WorkSpaces administrator send a report to https://console.aws.amazon.com/support/home#/. Device support might differ depending on which streaming protocol your WorkSpace is using, either PCoIP or DCV. In the 3.0+ versions of the macOS and Windows client applications, you can see which protocol your WorkSpace is using by choosing Support, About My WorkSpace. The iPad, Android, and Linux client applications currently support only the PCoIP protocol. Contents • Monitors • Keyboards and mice • Audio headsets • Printers • Scanners, USB drives, and other storage devices • Webcams and other video devices • Smart cards • Hardware security keys • WebAuthn authenticators Monitors The WorkSpaces client applications for Linux, macOS, and Windows support multiple monitors and the use of high DPI displays on both DCV and PCoIP WorkSpaces. For more information about display support on these WorkSpaces client applications, including how to set up multiple monitors, see Display Support for the Linux Client, Display Support for the macOS Client, or Display Support for the Windows Client. The WorkSpaces Android client application supports a single monitor and the use of high DPI displays on PCoIP WorkSpaces. For more information about display support in the WorkSpaces Android client application, see Display Support for the Android Client. Monitors 128 Amazon WorkSpaces User Guide For more information about support for high DPI displays, see Enabling high DPI display for WorkSpaces. Keyboards and mice The WorkSpaces client applications for Windows, macOS, and Linux support USB Bluetooth keyboards and mice. The WorkSpaces client applications for Android and iPad support touch input, and both clients offer on-screen keyboards and support keyboards attached to the device. The Android client supports mice, and iPads with iPadOS 13.4 or later support Bluetooth mice. The iPad client also supports certain SwiftPoint mice models. For more information, see Swiftpoint GT, ProPoint, or PadPoint mouse. 3D mice aren't supported by the WorkSpaces client applications. To use languages or keyboards other than English, see Language and keyboard settings for WorkSpaces. Audio headsets Analog and USB audio headsets are supported on the Android, iPad, macOS, Linux, and Windows client applications, and on the PCoIP Zero Client. We recommend using a headset for audio calls. If you use your device's built-in microphone and speakers, you might experience echoing during your conversations. If you're having difficulty using a headset, see My headset doesn't work in my WorkSpace. Printers The Windows and macOS client applications support USB printers and local printing. The other client applications support other printing methods. For details about printer support for the various clients, see Printing from a WorkSpace. If you're using a PCoIP zero client device to connect to your WorkSpace and you're having trouble using |
workspaces-ug-038 | workspaces-ug.pdf | 38 | client applications, and on the PCoIP Zero Client. We recommend using a headset for audio calls. If you use your device's built-in microphone and speakers, you might experience echoing during your conversations. If you're having difficulty using a headset, see My headset doesn't work in my WorkSpace. Printers The Windows and macOS client applications support USB printers and local printing. The other client applications support other printing methods. For details about printer support for the various clients, see Printing from a WorkSpace. If you're using a PCoIP zero client device to connect to your WorkSpace and you're having trouble using a USB printer or other USB peripheral devices, contact your WorkSpaces administrator for assistance. For more information, see USB printers and other USB peripherals aren't working for PCoIP zero clients in the Amazon WorkSpaces Administration Guide. Keyboards and mice 129 Amazon WorkSpaces User Guide Scanners, USB drives, and other storage devices The WorkSpaces clients do not support scanners or locally attached peripheral storage devices, such as USB flash drives or external hard drives. If you need to transfer, back up, or synchronize files between your WorkSpace and your local client device, consider emailing the files to yourself. To see if other solutions are available to you, contact your WorkSpaces administrator. Webcams and other video devices If your WorkSpace is using the PCoIP protocol, the WorkSpaces clients do not support webcams or other video devices. If your WorkSpace is using the DCV, versions 3.1.5 and later of the WorkSpaces client applications for Windows and macOS support webcams. For the Windows client, you must run the client on a machine that's running Windows 10 version 1607 or later. To use a webcam 1. Log in to your DCV WorkSpace. 2. Do one of the following, depending on which client you're using. If you're using... Windows client Do this To use a webcam on your DCV WorkSpace, select the Devices icon in the upper-right corner, and then select Use this device on the remote WorkSpace. Choose Save. To use a webcam on your local computer instead of on your DCV WorkSpace, select the Devices icon Scanners, USB drives, and other storage devices 130 Amazon WorkSpaces User Guide If you're using... Do this in the upper-right corner, and then select Use Locally. Choose Save. To use a webcam on your DCV WorkSpace , choose Connections, Devices, and then select Use this device on the remote WorkSpace. Choose Save. To use a webcam on your local computer instead of on your DCV WorkSpace, choose Connections, Devices, and then select Use on local machine. Choose Save. macOS client Smart cards If your WorkSpace is using the PCoIP protocol, the WorkSpaces clients do not support smart cards. If your Windows or Linux WorkSpace is using the DCV protocol, version 3.1.1 or later of the WorkSpaces client application for Windows and version 3.1.5 or later of the WorkSpaces client application for macOS support smart cards. For more information about using smart cards with your WorkSpace, see Smart card authentication for WorkSpaces client. Hardware security keys PCoIP Windows WorkSpaces support USB redirection for YubiKey U2F authentication with Windows WorkSpaces client apps. For more information, see USB redirection for WorkSpaces. To redirect YubiKey to a WorkSpace for U2F authentication • To use the YubiKey on your PCoIP WorkSpace, select the Devices icon in the upper-right corner, and then select Use this device on my remote WorkSpace. Choose Save. Smart cards 131 Amazon WorkSpaces User Guide • To use the YubiKey on your local computer instead of on your WorkSpace, select the in the upper-right corner, and then select Use on my local machine. Choose Save. WebAuthn authenticators If your WorkSpace is using the PCoIP protocol, WebAuthn redirection isn't supported. However, you can use USB redirection for hardware authenticators, see Hardware security keys WebAuthn redirection is supported for WorkSpaces using DCV protocol. For more information about using smart cards with your WorkSpace, see WebAuthn authentication for WorkSpaces client. WebAuthn authenticators 132 Amazon WorkSpaces User Guide File transfer support in the WorkSpaces client applications You can upload and download files on local computer and your My Storage folder if your WorkSpaces administrator has enabled file transfer. You can do the following with your My Storage folder: • Open and edit files and folders that you store in your My Storage folder. • Upload and download files between your local computer and your My Storage folder. Note If you're unable to do this, contact your WorkSpaces administrator to enable file transfer within your WorkSpaces session. • Rename the files or folders in the My Storage folder. Note File transfer is currently supported on personal Windows WorkSpaces when using the Windows or Linux client application, or web access. Contact your administrator if you have questions. To upload and download files between your local computer |
workspaces-ug-039 | workspaces-ug.pdf | 39 | your My Storage folder: • Open and edit files and folders that you store in your My Storage folder. • Upload and download files between your local computer and your My Storage folder. Note If you're unable to do this, contact your WorkSpaces administrator to enable file transfer within your WorkSpaces session. • Rename the files or folders in the My Storage folder. Note File transfer is currently supported on personal Windows WorkSpaces when using the Windows or Linux client application, or web access. Contact your administrator if you have questions. To upload and download files between your local computer and your My Storage folder 1. In the Amazon WorkSpaces client application, in the menu bar, choose File Transfer. A My Storage window will appear. 2. Navigate to an existing folder or choose Add Folder to create a new folder. 3. To upload a file to the folder, choose Upload File, select the file that you want to upload, and choose Open. To download a file from the folder, click on the file that you want to download, or choose the down arrow to the right of the file name and choose Download. 133 Amazon WorkSpaces User Guide Enabling high DPI display for WorkSpaces The Amazon WorkSpaces Android version 2.4.21 or later client application and the version 3.0+ client applications for Windows, macOS, and Linux support high pixel density (high DPI) displays. Screen resolution is defined by the number of pixels per inch (PPI) or dots per inch (DPI) that the screen can display horizontally and vertically. Some common screen resolutions are: • 1280x720 – High definition (HD), also known as 720p • 1920x1080 – FHD (Full HD), also known as 1080p • 2560x1440 – QHD/WQHD (Quad HD), also known as 1440p • 3840x2160 – UHD (Ultra HD), also known as 4K 2160p • 7680×4320 – FUHD (Full Ultra HD), also known as 8K 4320p Note Although all of these resolutions are labeled "high definition (HD)," that doesn't mean that a monitor with one of these resolutions is a high DPI display. Contents • Overview • Limitations • Enabling high DPI mode for Android • Enabling high DPI mode for Windows, macOS, or Linux • Adjusting the scaling settings on a Windows WorkSpace • Adjusting the scaling settings on a Linux WorkSpace Overview High DPI (also known as HiDPI) displays are those that use twice as many physical pixels to represent images than the virtual pixels that make up an image. For example, if an image is 128 virtual pixels wide and 128 virtual pixels tall, on a high DPI display that image would be rendered using 256 physical pixels in both directions, making the image twice as crisp. Overview 134 Amazon WorkSpaces User Guide For better maximum resolution of your WorkSpaces on high DPI displays, you can enable high DPI mode in the WorkSpaces client applications for Android, Windows, macOS, and Linux. Limitations Enabling high DPI mode might affect the performance of your WorkSpace. To accommodate the bandwidth of your network, the streaming protocol upgrades or downgrades the number of pixels that you receive as needed to maintain performance. However, in high latency, high packet loss, or low bandwidth environments, high DPI mode might affect the performance of your WorkSpace. We recommend that you turn off high DPI mode if it is affecting your WorkSpace performance. For Windows WorkSpaces, high DPI mode supports multiple monitors. However, the Android client supports only a single monitor. Note Graphics bundles support only a single monitor configuration with a maximum resolution of 2560x1600. The maximum display size supported for high DPI mode in the Amazon WorkSpaces client applications is 3840x2160. For more information about display support in the WorkSpaces client applications, see Display Support for the Android Client, Display Support for the Linux Client, Display Support for the macOS Client, or Display Support for the Windows Client. Enabling high DPI mode for Android To enable high DPI mode for Android 1. Open your Amazon WorkSpaces version 2.4.21 or later client application and log in to your WorkSpace. 2. In the WorkSpaces client application, swipe from the left side of the screen to open the sidebar menu, and then choose Settings. 3. In the Settings dialog box, select High DPI Mode, then choose OK. The screen resolution of your WorkSpace will change to match the high DPI resolution of your device. Limitations 135 Amazon WorkSpaces User Guide Enabling high DPI mode for Windows, macOS, or Linux To enable high DPI mode for Windows, macOS, or Linux 1. Open your Amazon WorkSpaces 3.0+ client application and log in to your WorkSpace. 2. 3. In the WorkSpaces client application, go to Settings, Display Settings. In the Display Settings dialog box, select High DPI Mode, then click Save. The screen resolution of your WorkSpace will change to |
workspaces-ug-040 | workspaces-ug.pdf | 40 | Settings dialog box, select High DPI Mode, then choose OK. The screen resolution of your WorkSpace will change to match the high DPI resolution of your device. Limitations 135 Amazon WorkSpaces User Guide Enabling high DPI mode for Windows, macOS, or Linux To enable high DPI mode for Windows, macOS, or Linux 1. Open your Amazon WorkSpaces 3.0+ client application and log in to your WorkSpace. 2. 3. In the WorkSpaces client application, go to Settings, Display Settings. In the Display Settings dialog box, select High DPI Mode, then click Save. The screen resolution of your WorkSpace will change to match the high DPI resolution of your monitor. Note If you're using a Mac and your screen resolution in WorkSpaces is low and objects look blurry, do the following: 1. Open System Preferences. 2. Choose Displays. 3. Do one of the following to adjust the display scaling, depending on your display type: If you're using... A built-in display An external display Do this On the Display tab, under Resolution, choose Scaled, and then choose Default. On the Display tab, choose Default for display. If the images and text in your WorkSpace are smaller than you prefer, you will also need to adjust the display scale settings on your Windows or Linux WorkSpace. Enabling high DPI mode for Windows, macOS, or Linux 136 Amazon WorkSpaces Important User Guide • Be sure to adjust the display scale settings within the WorkSpace itself, not the display scale settings for the local Windows, Linux, or Mac machine that you are using to access the WorkSpace. • When you dock or undock a laptop, or switch to another client device, you might need to readjust the scaling settings in the WorkSpace to suit the new monitor. Adjusting the scaling settings on a Windows WorkSpace To adjust the scaling settings on a Windows WorkSpace 1. 2. In your Windows WorkSpace, go to the Windows Start menu and choose Settings. In the Windows Settings dialog box, choose System. 3. Choose Display. Note If you see the message "The display settings cannot be changed from a remote session," this means that you're using a DCV WorkSpace. At this time, you can't adjust the display scale settings for a DCV WorkSpace. 4. Under Change the size of text, apps, and other items, set the amount of scaling you prefer. 5. A message appears that says "Some apps won't respond to scaling changes until you sign out." To sign out, you can choose Sign out now below that message. Note that signing out disconnects your WorkSpace session, so save your work before signing out. 6. To restart your WorkSpace session, either choose Reconnect on the WorkSpaces client login page, or log in again. 7. If you are using multiple monitors, repeat these steps to set the scaling settings for each monitor. Adjusting the scaling settings on a Windows WorkSpace 137 Amazon WorkSpaces User Guide Adjusting the scaling settings on a Linux WorkSpace To adjust the scaling settings on a Linux WorkSpace Note • These steps assume that you're using the default MATE environment for Amazon Linux WorkSpaces. • For Linux WorkSpaces, high DPI mode isn't available for multiple monitors at this time. 1. 2. In your Linux WorkSpace, go to System > Preferences > Appearance. In the Appearance Preferences dialog box, choose the Fonts tab. 3. Choose Details in the lower-right corner. 4. In the Font Rendering Details dialog box, under Resolution, you will see a Dots per inch (DPI) setting. To manually adjust this setting, turn off Automatic detection. 5. Adjust the font size by using the Dots per inch (DPI) setting. 6. Close the dialog box. Adjusting the scaling settings on a Linux WorkSpace 138 Amazon WorkSpaces User Guide Authentication for WorkSpaces You can use two authentication methods for your Amazon WorkSpaces, including using smart card authentication and WebAuthn. Contents • Smart card authentication for WorkSpaces client • WebAuthn authentication for WorkSpaces client Smart card authentication for WorkSpaces client Smart cards are supported using the DCV for Windows and Amazon Linux 2 WorkSpaces, on Windows and macOS clients. WorkSpaces using the PCoIP protocol do not support smart cards. Ubuntu, Rocky Linux, and Red Hat Enterprise Linux WorkSpaces do not currently support smart cards on any protocol. You can use smart cards for both pre-session authentication and in-session authentication. Authentication is the process of verifying your identity and confirming that you have access to certain resources. Pre-session authentication refers to smart card authentication that's performed while you're logging in to your WorkSpace. In-session authentication refers to authentication that's performed during your WorkSpace session, after you log in. For example, you can use smart cards for in-session authentication while working with web browsers and applications. You can also use smart cards for performing actions that require administrative permissions. For example, |
workspaces-ug-041 | workspaces-ug.pdf | 41 | not currently support smart cards on any protocol. You can use smart cards for both pre-session authentication and in-session authentication. Authentication is the process of verifying your identity and confirming that you have access to certain resources. Pre-session authentication refers to smart card authentication that's performed while you're logging in to your WorkSpace. In-session authentication refers to authentication that's performed during your WorkSpace session, after you log in. For example, you can use smart cards for in-session authentication while working with web browsers and applications. You can also use smart cards for performing actions that require administrative permissions. For example, if you have administrative permissions on your Linux WorkSpace, you can use smart cards to authenticate yourself when running sudo and sudo -i commands. Note • Both Common Access Card (CAC) and Personal Identity Verification Card 101 smart cards are supported. Other types of hardware or software-based smart cards might also work, but they haven't been fully tested for use with the DCV protocol. • For in-session authentication and pre-session authentication on Linux or Windows WorkSpaces, only one smart card is currently allowed at a time. Smart card authentication 139 Amazon WorkSpaces User Guide • In-session authentication is available in all Regions where DCV is supported. Pre-session authentication is available in the following Regions: • Asia Pacific (Sydney) Region • Asia Pacific (Tokyo) Region • Europe (Ireland) Region • AWS GovCloud (US-East) Region • AWS GovCloud (US-West) Region • US East (N. Virginia) Region • US West (Oregon) Region • Only the WorkSpaces Windows client application version 3.1.1 or later and the macOS client application version 3.1.5 or later are currently supported for smart card authentication. • The WorkSpaces Windows client application 3.1.1 or later supports smart cards only when the client is running on a 64-bit version of Windows. Contents • Use a smart card to log in to your WorkSpace • Use a smart card with Chrome or Firefox on Windows WorkSpaces (in-session) • Use a smart card with Chrome or Firefox on Linux WorkSpaces (in-session) Use a smart card to log in to your WorkSpace To use your smart card to log in to your WorkSpace 1. Enter the registration code provided by your WorkSpaces administrator, and then choose Register. You might need to choose Change Registration Code at the bottom of the login page so that you can enter a new registration code. After you've entered your registration code, Insert your smart card appears on the login page. If you don't see this text, verify that you've entered the correct registration code. If you've entered the correct registration code and you don't see this text, contact your WorkSpaces administrator for help. Use a smart card to log in to your WorkSpace 140 Amazon WorkSpaces User Guide 2. If you haven't done so already, plug your smart card reader into your local machine, and then insert your smart card into your smart card reader. 3. On the login page, choose Insert your smart card. 4. 5. The Certificates dialog box appears. Select your certificate, and then choose OK. The Smart Card dialog box appears. Enter your PIN, and then choose OK. 6. On the Windows desktop login page, choose Sign-in options, then choose the smart card icon. If you have multiple smart cards, choose the one you want to use. Enter your PIN again, then choose Submit. On the Linux login page, enter your PIN and choose Sign In. You should be logged in to your WorkSpace. If you're unable to sign in, close and reopen the WorkSpaces client application, and then try again. After trying again, if you still aren't able to sign in, contact your WorkSpaces administrator for help. After you have logged in to your WorkSpace, you can continue to use the smart card on your local device as well as in the WorkSpace. Use a smart card with Chrome or Firefox on Windows WorkSpaces (in- session) You can use a smart card within a Windows WorkSpace, on Chrome or Firefox, to authenticate other applications. Chrome doesn't require any special configuration to work with your smart card. You WorkSpaces administrator may have already enabled Firefox to work with smart cards. If you want to use a smart card on Firefox but it doesn't work, contact your WorkSpaces administrator. Use a smart card with Chrome or Firefox on Linux WorkSpaces (in- session) You can use a smart card within a Linux WorkSpace, on Chrome or Firefox, to authenticate other applications. To use your smart card with the Chrome browser 1. Log in to your Linux WorkSpace using the WorkSpaces for Windows client application. 2. Open Terminal (Applications > System Tools > MATE Terminal). Use a smart card with Chrome or Firefox on Windows WorkSpaces (in-session) 141 Amazon WorkSpaces 3. Run the following command: User Guide |
workspaces-ug-042 | workspaces-ug.pdf | 42 | use a smart card on Firefox but it doesn't work, contact your WorkSpaces administrator. Use a smart card with Chrome or Firefox on Linux WorkSpaces (in- session) You can use a smart card within a Linux WorkSpace, on Chrome or Firefox, to authenticate other applications. To use your smart card with the Chrome browser 1. Log in to your Linux WorkSpace using the WorkSpaces for Windows client application. 2. Open Terminal (Applications > System Tools > MATE Terminal). Use a smart card with Chrome or Firefox on Windows WorkSpaces (in-session) 141 Amazon WorkSpaces 3. Run the following command: User Guide cd; modutil -dbdir sql:.pki/nssdb/ -add "OpenSC" -libfile /lib64/opensc-pkcs11.so 4. If Chrome is already running, close it, and then press Enter. When the command finishes running, you should see this message: Module "OpenSC" added to database. To use your smart card with the Firefox browser Your WorkSpaces administrator might have already enabled Firefox to work with smart cards. If your smart card doesn't work in Firefox, use the following procedure to enable it. 1. Open Firefox. Choose the menu button in the upper-right corner, and then choose Preferences. 2. On the about:preferences page, in the left navigation pane, choose Privacy & Security. 3. Under Certificates, choose Security Devices. 4. 5. In the Device Manager dialog box, choose Load. In the Load PKCS#11 Device Driver dialog box, enter the following: Module Name: OpenSC Module filename: /lib64/opensc-pkcs11.so 6. Choose OK. WebAuthn authentication for WorkSpaces client In-session WebAuthn authentication is supported using the DCV for Windows WorkSpaces, on Windows, Linux and macOS clients. WorkSpaces using the PCoIP protocol doesn't support WebAuthn redirection. You can use WebAuthn authentication for in-session authentication. In-session authentication refers to WebAuthn authentication that's performed after logging in and requested by the web applications running within the session. For example, you can use Yubikey for in-session authentication while using Google Chrome. WebAuthn authentication 142 Amazon WorkSpaces User Guide Your WorkSpaces administrator can enable and disable WebAuthn. Your browser will notify you that the required browser extension is installed for you when your administrator enables it. To install the browser extension manually (optional) 1. 2. 3. Sign in your WorkSpace. In your browser, open one of the following links, depending on which browser you're using: • For Microsoft Edge: https://microsoftedge.microsoft.com/addons/detail/dcv-webauthn- redirection-/ihejeaahjpbegmaaegiikmlphghlfmeh • For Google Chrome: https://chromewebstore.google.com/detail/dcv-webauthn- redirection/mmiioagbgnbojdbcjoddlefhmcocfpmn?pli=1 Install the extension by choosing Get (for Microsoft Edge) or Add to Chrome (for Google Chrome), then at the additional prompt, choose Add extension. Once the installation is finished, you'll see a confirmation message saying that you've successfully added the extension. WebAuthn authentication 143 Amazon WorkSpaces User Guide Amazon Connect audio optimization for WorkSpaces Amazon WorkSpaces allows you to add Amazon Connect Contact Control Panel (CCP) to your WorkSpace so you can use Amazon Connect audio optimization. To use Amazon Connect audio optimization with your WorkSpace: • You must have the WorkSpaces Windows client version 4.0.6 or later installed. • You must have a web browser installed onto the WorkSpaces client endpoint that's supported by Amazon Connect. For the list of supported browsers, see Browsers supported by Amazon Connect. Note If you do not have a supported web browser, you will be asked to install a supported browser. • You must have an existing Amazon Connect account. Log in to your WorkSpace and Amazon Connect Contact Control Panel (CCP) Log in to your WorkSpace and Amazon Connect Contact Control Panel (CCP) After your administrator has enabled Amazon Connect Contact Control Panel (CCP) audio optimization, log in to your WorkSpace and the CCP Panel. 1. Open the WorkSpaces client and log in to your WorkSpace. 2. A web browser will open locally, displaying your CCP login page. 3. Log in to your CCP in the local browser window. When you have logged in, CCP audio optimization is enabled. 4. Switch back to your WorkSpaces window, but keep the local browser window running in the background. Log in to your WorkSpace and Amazon Connect Contact Control Panel (CCP) 144 Amazon WorkSpaces User Guide Warning • If you close the local browser window that you used to log in to CCP, you will lose your CCP audio (though your WorkSpaces client will continue running). • If you close your WorkSpaces window, your local browser window will also close, and your CCP audio will stop. If you accidentally close your local browser CCP window or if it crashes, you can restart it. Go to the menu bar, select Add-in, and then select the administrator-given CCP name. For more information about using Amazon Connect, go to the Agent training guide. Log in to your WorkSpace and Amazon Connect Contact Control Panel (CCP) 145 Amazon WorkSpaces User Guide Language and keyboard settings for WorkSpaces To use the same language and keyboard settings on your client device and your WorkSpace, use one |
workspaces-ug-043 | workspaces-ug.pdf | 43 | your WorkSpaces window, your local browser window will also close, and your CCP audio will stop. If you accidentally close your local browser CCP window or if it crashes, you can restart it. Go to the menu bar, select Add-in, and then select the administrator-given CCP name. For more information about using Amazon Connect, go to the Agent training guide. Log in to your WorkSpace and Amazon Connect Contact Control Panel (CCP) 145 Amazon WorkSpaces User Guide Language and keyboard settings for WorkSpaces To use the same language and keyboard settings on your client device and your WorkSpace, use one of the following methods, depending on which protocol your WorkSpace is using: PCoIP or DCV. Note The following procedures might require you to sign out of Windows or disconnect from your WorkSpace. Be sure to save your work before proceeding. WorkSpaces using the PCoIP protocol If you're using a language-specific keyboard, use one of the following methods to make your keyboard and your WorkSpace language settings match. • Method 1 — Change the keyboard and language settings on your device so that they match the language of your WorkSpace. • Method 2 — If you are in an AWS Region that supports more than one language, have your WorkSpaces administrator create a WorkSpace for you in your preferred language. Windows WorkSpaces are currently available in all Regions in English (US). In certain Regions, other languages are available. In the Canada (Central) Region, Windows WorkSpaces are also available in French (Canadian); in the Asia Pacific (Seoul) Region, Korean is also available; in the Asia Pacific (Tokyo) Region, Japanese is also available; and in the China (Ningxia) Region, Chinese (Simplified) is also available. To see which Region your WorkSpace is in, log in to the WorkSpaces client application, and then choose Support, About My WorkSpace. • Method 3 — Install the appropriate language or keyboard settings on your WorkSpace. For a Windows WorkSpace, use the following steps: 1. Log in to the WorkSpace. 2. On the Windows Start menu, choose Settings. 3. Choose Time & Language, and then choose Language. 4. Under Preferred languages, choose Add a language. WorkSpaces using the PCoIP protocol 146 Amazon WorkSpaces User Guide 5. In the Choose a language to install dialog box, select the language to add, and then choose Next. 6. In the Install language features dialog box, select the language features that you want, and then choose Install. For example, if you only want to add support for a language-specific keyboard, select Basic typing to install keyboard support for that language. 7. (Optional) If you've chosen a new display language, sign out of Windows and then sign back in to see the changes take effect. 8. If you didn't change the display language, select the new keyboard layout for the language that you installed. To do so, in the Windows taskbar, choose ENG in the lower-right corner next to the date and time. A menu appears. Select the language keyboard that you want to use for input. WorkSpaces using the DCV protocol The following languages require the use of an Input Method Editor (IME) to enter characters that aren't found on a QWERTY keyboard: • Amharic (Ethiopia) • Chinese (PRC) • Chinese (Traditional) • Chinese (Traditional DaYi input method) • Chinese (Wubi input method) • Chinese (Yi script) • Japanese (Japan) • Japanese (106/109 keyboard layout) • Korean (Hangul) • Korean (Old Hangul) • Tigrinya (Ethiopia) If you want to use a specific keyboard language layout while using DCV, you can follow one of the following instructions based on whether you're using an IME language or a non-IME language. WorkSpaces using the DCV protocol 147 Amazon WorkSpaces Note User Guide If you want to use the Japanese 106/109 keyboard layout, be sure to use the procedure specific to the Japanese 106/109 layout. To use a non-IME language If you're using a non-IME language (for example, French), use the following procedure. 1. Set the local client device to the language-specific keyboard that you want. a. On the Windows Start menu, choose Settings. b. Choose Time & language. c. Choose Language. d. Under Preferred languages, select Add a language. e. On the Choose a language to install page, select the language you want. f. Choose Next. g. Choose Install. h. If needed, set your language-specific keyboard layout by selecting the language and then choosing Options. i. (Optional) If you chose a new display language, sign out of Windows so that the new display language can take effect. 2. Select the new keyboard layout for the language that you installed. To do so, in the Windows taskbar, choose ENG in the lower-right corner next to the date and time. A menu appears. Select the language keyboard that you want to use for input. To change the display |
workspaces-ug-044 | workspaces-ug.pdf | 44 | install page, select the language you want. f. Choose Next. g. Choose Install. h. If needed, set your language-specific keyboard layout by selecting the language and then choosing Options. i. (Optional) If you chose a new display language, sign out of Windows so that the new display language can take effect. 2. Select the new keyboard layout for the language that you installed. To do so, in the Windows taskbar, choose ENG in the lower-right corner next to the date and time. A menu appears. Select the language keyboard that you want to use for input. To change the display language in your WorkSpaces desktop client application, see Client Language (Linux), Client Language (macOS), or Client Language (Windows). To use an IME language other than Japanese 106/109 If you're using an IME language other than the Japanese 106/109 keyboard layout (for example, Korean), use the following procedure. 1. Set the local client device's keyboard layout to the IME language that you want. WorkSpaces using the DCV protocol 148 Amazon WorkSpaces User Guide a. On the Windows Start menu, choose Settings. b. Choose Time & language. c. Choose Language. d. Under Preferred languages, select Add a language. e. On the Choose a language to install page, select the language that you want. f. Choose Next. g. Choose Install. h. If needed, set your language-specific keyboard layout by selecting the language and then choosing Options. i. (Optional) If you chose a new display language, sign out of Windows so that the new display language can take effect. Select the new keyboard layout for the language that you installed. To do so, in the Windows taskbar, choose ENG in the lower-right corner next to the date and time. A menu appears. Select the language keyboard that you want to use for input. Start your WorkSpaces client application and log into your DCV WorkSpace. Inside the WorkSpace, set the input language to the IME language that you want. 2. 3. 4. a. On the Windows Start menu, choose Settings. b. Choose Time & language. c. Choose Region & language. d. Under Languages, select Add a language. e. On the Add a language page, select the IME language that you want. f. (Optional) If needed, set your language-specific keyboard layout by selecting the language on the Language page and then choosing Options. g. (Optional) If you chose a new display language, sign out of Windows so that the new display language can take effect. When you sign out, you're also disconnected from your WorkSpace. 5. Disconnect from your WorkSpace (if you didn't already do so in the previous step). 6. Reconnect to your WorkSpace. 7. Inside the WorkSpace, in the Windows taskbar, choose ENG in the lower-right corner next to the date and time. A menu appears. Select the IME language that you installed. WorkSpaces using the DCV protocol 149 Amazon WorkSpaces User Guide You can now use your IME language in your DCV WorkSpace. To change the display language in your WorkSpaces desktop client application, see Client Language (Linux), Client Language (macOS), or Client Language (Windows). To use the Japanese 106/109 keyboard layout If you're using the Japanese 106/109 keyboard layout, use the following procedure. 1. Set the local client device’s display language to Japanese, and set the keyboard to use the Japanese 106/109 keyboard layout. a. On the Windows Start menu, choose Settings. b. Choose Time & language. c. Choose Language. d. Under Preferred languages, select Add a language. e. On the Choose a language to install page, select Japanese. f. Choose Next. g. On the Install language features page, choose Install. h. On the Languages page, select Japanese, and then choose Options. i. j. k. In the Language options: Japanese page, under Hardware keyboard layout, choose Change layout. In the Change hardware keyboard layout dialog box, select Japanese keyboard (106/109 key). The change doesn't take effect until you restart Windows. Either choose Restart now, or choose OK, save your work, and then restart Windows. 2. 3. 4. Select the new keyboard layout that you installed. To do so, in the Windows taskbar, choose ENG in the lower-right corner next to the date and time. A menu appears. Select Japanese Microsoft IME. Start your WorkSpaces client application and log into your DCV WorkSpace. Inside the WorkSpace, set Japanese as the default display language and set the keyboard layout to Japanese 106/109. a. On the Windows Start menu, choose Settings. b. Choose Time & language. c. Choose Region & language. WorkSpaces using the DCV protocol 150 Amazon WorkSpaces User Guide d. Under Languages, select Add a language. e. On the Add a language page, select Japanese. f. On the Languages page, select Japanese, and then choose Set as default. g. On the Languages page, select Japanese, and then choose Options. h. i. In the |
workspaces-ug-045 | workspaces-ug.pdf | 45 | your WorkSpaces client application and log into your DCV WorkSpace. Inside the WorkSpace, set Japanese as the default display language and set the keyboard layout to Japanese 106/109. a. On the Windows Start menu, choose Settings. b. Choose Time & language. c. Choose Region & language. WorkSpaces using the DCV protocol 150 Amazon WorkSpaces User Guide d. Under Languages, select Add a language. e. On the Add a language page, select Japanese. f. On the Languages page, select Japanese, and then choose Set as default. g. On the Languages page, select Japanese, and then choose Options. h. i. In the Language options page, under Hardware keyboard layout, choose Change layout. In the Change hardware keyboard layout dialog box, select Japanese keyboard (106/109 key). j. The change doesn't take effect until you sign out of Windows. Choose Sign out. You will be signed out of Windows and disconnected from your WorkSpace. 5. Reconnect to your WorkSpace. 6. Inside the WorkSpace, in the Windows taskbar, choose ENG in the lower-right corner next to the date and time. A menu appears. Select Japanese Microsoft IME. You can now use the Japanese 106/109 keyboard layout in your DCV WorkSpace. To change the display language in your WorkSpaces desktop client application, see Client Language (Linux), Client Language (macOS), or Client Language (Windows). WorkSpaces using the DCV protocol 151 Amazon WorkSpaces User Guide USB redirection for WorkSpaces Universal Serial Bus (USB) is used to connect computers to devices, such as scanners, printers, external drives, and security keys. PCoIP Windows WorkSpaces support redirection of a locally attached YubiKey for universal 2nd factor authentication from the Windows WorkSpaces client application. Note YubiKey redirection is only supported for Windows WorkSpaces clients. Contents • Requirements • Supported USB devices • Supported USB devices • Connecting your USB device to your WorkSpace • Disconnecting your USB device from your WorkSpace • Reinstalling or upgrading your USB redirection drivers Requirements • USB redirection is disabled by default on Windows PCoIP WorkSpaces. You must enable USB redirection for WorkSpaces. You can configure USB allowed and unallowed device rules to define which devices can be redirected. For more information, see Manage your Windows WorkSpaces • Install WorkSpaces client version 4.0 or later, with the USB redirection driver, locally. For more information, see Setup and Installation. Supported USB devices The following is a list of USB YubiKey models that are validated to work with the PCoIP Windows WorkSpaces redirection for U2F: • YubiKey 4 Requirements 152 Amazon WorkSpaces • YubiKey 5 NFC • YubiKey 5 Nano • YubiKey 5C • YubiKey 5C Nano • YubiKey 5 NFC User Guide • Most USB type C to USB type A adapters can be used with a supported YubiKey Supported USB devices Most USB mass storage devices and some scanners and printers use data transfer types, including control, interrupt, and bulk. Devices using these data transfer types are not supported but they may be redirected in your WorkSpaces. Isochronous transfers, which are commonly used in webcams, are not supported. Therefore, USB webcams are not supported. The following USB device is validated to work with PCoIP WorkSpaces for U2F authentication, although it is not supported: • Thetis Security Key The following USB device doesn't work with PCoIP WorkSpaces for U2F authentication: • Kensington Security Key Connecting your USB device to your WorkSpace To connect your local USB device to your WorkSpace Warning When you connect a local USB device to your WorkSpace, it is no longer available for use by your local computer. For example, if you redirect your USB mouse to the WorkSpace, your computer cannot receive mouse input from the redirected USB mouse until you disconnect it from the WorkSpace. Supported USB devices 153 Amazon WorkSpaces User Guide USB device connections do not persist across WorkSpaces streaming sessions. You must connect your USB device each time that you connect to your WorkSpace. Up to 10 USB devices can be redirected concurrently in a WorkSpaces streaming session. 1. Log in to a PCoIP Windows WorkSpace using the WorkSpaces Windows client application. 2. On the client interface, click the Devices icon to list the locally attached USB devices. 3. Select the USB device and choose Use with WorkSpaces from the menu next to the device name. 4. Your USB device is ready to use with your WorkSpace. Disconnecting your USB device from your WorkSpace To disconnect your local USB device from your WorkSpace 1. On the client interface, click the icon to list the locally attached USB devices. 2. Select the USB device and choose Use with local device from the menu next to the device name. 3. Your USB device is ready to use with your local computer. Reinstalling or upgrading your USB redirection drivers To reinstall or upgrade USB redirection drivers Follow these steps to do a |
workspaces-ug-046 | workspaces-ug.pdf | 46 | the menu next to the device name. 4. Your USB device is ready to use with your WorkSpace. Disconnecting your USB device from your WorkSpace To disconnect your local USB device from your WorkSpace 1. On the client interface, click the icon to list the locally attached USB devices. 2. Select the USB device and choose Use with local device from the menu next to the device name. 3. Your USB device is ready to use with your local computer. Reinstalling or upgrading your USB redirection drivers To reinstall or upgrade USB redirection drivers Follow these steps to do a clean re-installation or upgrade of the drivers. 1. Uninstall the USB redirection drivers by running the following command. [Amazon WorkSpaces directory]\pcoipusb\bin\USB\PCoIP_Client_USB_uninstaller.exe 2. Reboot your machine. 3. Open the Registry Editor editor. 4. Under HKLM, search for fusbhub. 5. Remove the registry key, which is the item in the left pane with the folder icon. In this case it is the fuhub key, containing fusbhub. If you cannot remove this registry key, make note of the .inf file name that's associated with the registry entry. The .inf file name usually starts with Disconnecting your USB device from your WorkSpace 154 Amazon WorkSpaces User Guide "oem," for example "oem9.inf". Open the command line (using administrator privileges), and run the following prompt, substituting the .inf file name for oem9.inf. pnputil -f -d oem9.inf 6. Repeat step 5 until fusbhub is completely removed from the registry editor. 7. Reboot your machine. 8. For upgrades only, you must download the latest client and install it. You can choose to install USB drivers during the client installation. 9. After you log into your WorkSpace, select the Devices icon and reinstall the USB driver. Alternatively, you can invoke the following PowerShell script (using administrator privileges). , [Amazon WorkSpaces directory]\pcoipusb\install-pcoip-usb-driver.ps1 Reinstalling or upgrading your USB redirection drivers 155 Amazon WorkSpaces User Guide Printing from a WorkSpace The following printing methods are supported by Amazon WorkSpaces. Note • The WorkSpaces clients for iPad, Android, Chromebook, Web Access, and Linux support network printing and cloud printing services. Local printing is not currently supported for the iPad, Android, Chromebook, Web Access, and Linux clients. • Local printer redirection is not available for Linux WorkSpaces, regardless of the client being used to access them. • If you're using a PCoIP zero client device to connect to your WorkSpace and you're having trouble using a USB printer or other USB peripheral devices, contact your WorkSpaces administrator for assistance. For more information, see USB printers and other USB peripherals aren't working for PCoIP zero clients in the Amazon WorkSpaces Administration Guide. Printing methods • Local printers • Other printing methods Local printers Windows WorkSpaces support local printer redirection. When you print from an application in your WorkSpace, the local printers are contained in your list of available printers. The local printers have "(Local – workspace username.directory name.client computer name)" appended to the printer's display name. Select one of the local printers and your documents are printed on that printer. In some cases, you need to download and install the driver for your local printer manually on the WorkSpace. When you install a printer driver on your WorkSpace, there are different types of drivers that you might encounter: • Add Printer wizard driver. This driver includes only the printer drivers, and is for users who are familiar with installation using the Add Printer wizard in Windows. Local printers 156 Amazon WorkSpaces User Guide • Printer model-specific drivers that do not require communication with the printer. In these cases, you can install the printer driver directly. • Printer model-specific drivers that require communication with the printer. In these cases, you can use the printer driver files to add a local printer using an existing port (LPT1:). After selecting the port, you can choose Have Disk and select the .INF file for the printer driver. After installing the printer driver, you must restart (reboot) the WorkSpace for the new printer to be recognized. If you cannot print to your local printer from your WorkSpace, make sure that you can print to your local printer from your client computer. If you cannot print from your client computer, refer to the printer documentation and support to resolve the issue. If you can print from your client computer, contact AWS Support for further assistance. Other printing methods You can also use one of the following methods to print from a Windows or Linux WorkSpace: • If your organization exposes printers through Active Directory, you can connect your WorkSpace to printers on your internal company network. • Print to a file, transfer the file to your local desktop and print the file locally to an attached printer. Other printing methods 157 Amazon WorkSpaces User Guide Troubleshoot WorkSpaces client issues The following |
workspaces-ug-047 | workspaces-ug.pdf | 47 | to the printer documentation and support to resolve the issue. If you can print from your client computer, contact AWS Support for further assistance. Other printing methods You can also use one of the following methods to print from a Windows or Linux WorkSpace: • If your organization exposes printers through Active Directory, you can connect your WorkSpace to printers on your internal company network. • Print to a file, transfer the file to your local desktop and print the file locally to an attached printer. Other printing methods 157 Amazon WorkSpaces User Guide Troubleshoot WorkSpaces client issues The following are common issues that you might have with your WorkSpaces client. Issues • I didn't receive an email with my Amazon WorkSpaces registration code • After logging in, the Windows client application displays only a white page and I cannot connect to my WorkSpace • My WorkSpaces client gives me a network error, but I am able to use other network-enabled apps on my device • It sometimes takes several minutes to log in to my Windows WorkSpace • When I try to log in, the Amazon WorkSpaces Windows client gets stuck on the "Preparing your login page" screen • When I try to log in, I get the error message: "No network. Network connection lost. Check your network connection or contact your administrator for help." • The Amazon WorkSpaces Windows client application login page is very tiny • I see the following error message: "WorkSpace Status: Unhealthy. We were unable to connect you to your WorkSpace. Please try again in a few minutes." • Sometimes I am logged off of my Windows WorkSpace, even though I closed the session, but did not log off • I forgot my password and tried to reset it, but I didn’t receive an email with a reset link • I can't connect to the internet from my WorkSpace • I installed a third-party security software package and now I can't connect to my WorkSpace • I am getting a "network connection is slow" warning when connected to my WorkSpace • I got an "invalid certificate" error on the client application. What does that mean? • I'm having trouble when I try to connect to my Windows WorkSpace using Web Access • I see the following error message: "Device can't connect to the registration service. Check your network settings." • I skipped an update to my client application and am having trouble updating my client to the latest version • My headset doesn't work in my WorkSpace • I am unable to install the Android client application on my Chromebook 158 Amazon WorkSpaces User Guide • I'm getting the wrong characters when I type; for example, I get \ and | when I try to type quotation marks (' and ") • The WorkSpaces client application won't run on my Mac • I'm having trouble using the Windows logo key in Windows WorkSpaces when working on a Mac • My WorkSpace looks blurry on my Mac • I'm having trouble copying and pasting • My screen is flickering or not updating properly, or my mouse isn't clicking in the right place • The WorkSpaces client for Windows prompts to update to a version that is already installed • I don't see video-in devices listed under Devices on my WorkSpaces Windows client I didn't receive an email with my Amazon WorkSpaces registration code Contact your WorkSpaces administrator for assistance. After logging in, the Windows client application displays only a white page and I cannot connect to my WorkSpace This problem can be caused by expired Verisign/Symantec certificates on your client computer (not your WorkSpace). Remove the expired certificate and launch the client application again. To find and remove expired Verisign/Symantec certificates 1. In the Windows Control Panel on your client computer (not your WorkSpace), choose Network and Internet. 2. Choose Internet Options. 3. 4. In the Internet Properties dialog box, choose Content, Certificates. In the Certificates dialog box, choose the Intermediate Certificate Authorities tab. In the list of certificates, select all certificates that were issued by Verisign or Symantec that are also expired, and choose Remove. Do not remove any certificates that are not expired. 5. On the Trusted Root Certificate Authorities tab, select all certificates that were issued by Verisign or Symantec that are also expired, and choose Remove. Do not remove any certificates that are not expired. I didn't receive an email with my Amazon WorkSpaces registration code 159 Amazon WorkSpaces User Guide 6. Close the Certificates dialog box and the Internet Properties dialog box. My WorkSpaces client gives me a network error, but I am able to use other network-enabled apps on my device The WorkSpaces client applications rely on access to resources in the AWS Cloud, and require a connection that |
workspaces-ug-048 | workspaces-ug.pdf | 48 | 5. On the Trusted Root Certificate Authorities tab, select all certificates that were issued by Verisign or Symantec that are also expired, and choose Remove. Do not remove any certificates that are not expired. I didn't receive an email with my Amazon WorkSpaces registration code 159 Amazon WorkSpaces User Guide 6. Close the Certificates dialog box and the Internet Properties dialog box. My WorkSpaces client gives me a network error, but I am able to use other network-enabled apps on my device The WorkSpaces client applications rely on access to resources in the AWS Cloud, and require a connection that provides at least 1 Mbps download bandwidth. If your device has an intermittent connection to the network, the WorkSpaces client application might report an issue with the network. WorkSpaces enforces the use of digital certificates issued by Amazon Trust Services, as of May 2018. Amazon Trust Services is already a trusted Root certificate authority (CA) on the operating systems that are supported by WorkSpaces. If the Root CA list for your operating system is not up to date, your device cannot connect to WorkSpaces and the client gives a network error. To recognize connection issues due to certificate failures • PCoIP zero clients — The following error message is displayed: Failed to connect. The server provided a certificate that is invalid. See below for details: - The supplied certificate is invalid due to timestamp - The supplied certificate is not rooted in the devices local certificate store • Other clients — The health checks fail with a red warning triangle for Internet. To resolve certificate failures Use one of the following solutions for certificate failures. • For the Windows client, download and install the latest Windows client application from https:// clients.amazonworkspaces.com/ . During installation, the client application ensures that your operating system trusts certificates issued by Amazon Trust Services. If updating your client does not resolve the issue, contact your Amazon WorkSpaces administrator. • For all other clients, contact your Amazon WorkSpaces administrator. My WorkSpaces client gives me a network error, but I am able to use other network-enabled apps on my device 160 Amazon WorkSpaces User Guide It sometimes takes several minutes to log in to my Windows WorkSpace Group Policy settings that are set by your system administrator can cause a delay on login after your Windows WorkSpace has been launched or rebooted. This delay occurs while the Group Policy settings are being applied to the WorkSpace, and is normal. When I try to log in, the Amazon WorkSpaces Windows client gets stuck on the "Preparing your login page" screen When starting versions 3.0.4 and 3.0.5 of the WorkSpaces Windows client application on a Windows 10 machine, the client might get stuck on the "Preparing your login page" screen. To avoid this issue, either upgrade to version 3.0.6 of the Windows client application or do not run the Windows client application with administrator (elevated) privileges. When I try to log in, I get the error message: "No network. Network connection lost. Check your network connection or contact your administrator for help." When you try to log in to your WorkSpace using some 3.0+ versions of the Windows, macOS, and Linux WorkSpaces client applications, you might receive a "No network" error on the login page if you have specified a custom proxy server. • Windows client — To avoid this issue with the Windows client, upgrade to version 3.0.12 or later. For more information about configuring the proxy server settings in the Windows client, see Proxy Server for Windows Client. • macOS client — To work around this issue, use the proxy server that's specified in the device operating system instead of using a custom proxy server. For more information about configuring the proxy server settings in the macOS client, see Proxy Server for macOS Client. • Linux client — To avoid this issue with the Linux client, upgrade to version 3.1.5 or later. If you can't upgrade, you can work around this issue by using the proxy server that's specified in the device operating system instead of using a custom proxy server. For more information about configuring the proxy server settings in the Linux client, see Proxy Server for Linux Client. It sometimes takes several minutes to log in to my Windows WorkSpace 161 Amazon WorkSpaces User Guide The Amazon WorkSpaces Windows client application login page is very tiny Running the WorkSpaces Windows client with administrator (elevated) privileges might result in viewing issues in high DPI environments. To avoid these issues, run the client in user mode instead. I see the following error message: "WorkSpace Status: Unhealthy. We were unable to connect you to your WorkSpace. Please try again in a few minutes." If you just started or restarted your WorkSpace, wait a few minutes, and then try |
workspaces-ug-049 | workspaces-ug.pdf | 49 | for Linux Client. It sometimes takes several minutes to log in to my Windows WorkSpace 161 Amazon WorkSpaces User Guide The Amazon WorkSpaces Windows client application login page is very tiny Running the WorkSpaces Windows client with administrator (elevated) privileges might result in viewing issues in high DPI environments. To avoid these issues, run the client in user mode instead. I see the following error message: "WorkSpace Status: Unhealthy. We were unable to connect you to your WorkSpace. Please try again in a few minutes." If you just started or restarted your WorkSpace, wait a few minutes, and then try to log in again. If you continue to receive this error message, you can try the following actions (if your WorkSpaces administrator has enabled you to do them): • Restarting a WorkSpace • Rebuilding a WorkSpace If you are unable to restart or rebuild the WorkSpace yourself, or if you continue to see the error message after doing so, contact your WorkSpaces administrator for assistance. Sometimes I am logged off of my Windows WorkSpace, even though I closed the session, but did not log off Your system administrator applied a new or updated Group Policy setting to your Windows WorkSpace that requires a logoff of a disconnected session. I forgot my password and tried to reset it, but I didn’t receive an email with a reset link Contact your WorkSpaces administrator for assistance. Contact your company's IT department if you don't know who your WorkSpaces administrator is. The Amazon WorkSpaces Windows client application login page is very tiny 162 Amazon WorkSpaces User Guide I can't connect to the internet from my WorkSpace WorkSpaces cannot communicate with the internet by default. Your Amazon WorkSpaces administrator must explicitly provide internet access. I installed a third-party security software package and now I can't connect to my WorkSpace You can install any type of security or firewall software on your WorkSpace, but WorkSpaces requires that certain inbound and outbound ports are open on the WorkSpace. If the security or firewall software that you install blocks these ports, the WorkSpace might not function correctly or might become unreachable. For more information, see Port Requirements for WorkSpaces in the Amazon WorkSpaces Administration Guide. To restore your WorkSpace, rebuild your WorkSpace if you still have access to it, or ask your Amazon WorkSpaces administrator to rebuild your WorkSpace. You then have to reinstall the software and properly configure port access for your WorkSpace. I am getting a "network connection is slow" warning when connected to my WorkSpace If the round-trip time from your client to your WorkSpace is longer than 100ms, you can still use your WorkSpace, but this might result in a poor experience. A slow round-trip time can be caused by many factors, but the following are the most common causes: • You are too far from the AWS Region that your WorkSpace resides in. For the best WorkSpace experience, you should be within 2,000 miles of the AWS Region that your WorkSpace is in. • Your network connection is inconsistent or slow. For the best experience, your network connection should provide at least 300 kbps, with capability to provide over 1 Mbps when viewing video or using graphics-intensive applications on your WorkSpace. I got an "invalid certificate" error on the client application. What does that mean? The WorkSpaces client application validates the identity of the WorkSpaces service through an SSL/TLS certificate. If the root certificate authority of the Amazon WorkSpaces service cannot I can't connect to the internet from my WorkSpace 163 Amazon WorkSpaces User Guide be verified, the client application displays an error and prevents any connection to the service. The most common cause is a proxy server that is removing the root certificate authority and returning an incomplete certificate to the client application. Contact your network administrator for assistance. I'm having trouble when I try to connect to my Windows WorkSpace using Web Access Windows WorkSpaces rely on a specific login screen configuration to enable you to log in from your Web Access client. Your Amazon WorkSpaces administrator might need to configure Group Policy and Security Policy settings to enable you to log in to your WorkSpace from your Web Access client. If these settings are not correctly configured, you might experience long login times or black screens when you try to log in to your WorkSpace. Contact your Amazon WorkSpaces administrator for assistance. Important Beginning October 1, 2020, customers will no longer be able to use the Amazon WorkSpaces Web Access client to connect to Windows 7 custom WorkSpaces or to Windows 7 Bring Your Own License (BYOL) WorkSpaces. I see the following error message: "Device can't connect to the registration service. Check your network settings." When a registration service failure occurs, you might see the following error message on the |
workspaces-ug-050 | workspaces-ug.pdf | 50 | If these settings are not correctly configured, you might experience long login times or black screens when you try to log in to your WorkSpace. Contact your Amazon WorkSpaces administrator for assistance. Important Beginning October 1, 2020, customers will no longer be able to use the Amazon WorkSpaces Web Access client to connect to Windows 7 custom WorkSpaces or to Windows 7 Bring Your Own License (BYOL) WorkSpaces. I see the following error message: "Device can't connect to the registration service. Check your network settings." When a registration service failure occurs, you might see the following error message on the Connection Health Check page: "Your device is not able to connect to the WorkSpaces Registration service. You will not be able to register your device with WorkSpaces. Please check your network settings." This error occurs when the WorkSpaces client application can't reach the registration service. Contact your Amazon WorkSpaces administrator for assistance. I'm having trouble when I try to connect to my Windows WorkSpace using Web Access 164 Amazon WorkSpaces User Guide I skipped an update to my client application and am having trouble updating my client to the latest version If you've skipped an update to your Amazon WorkSpaces Windows client application and now want to update to the latest version of the client, see Update the WorkSpaces Windows client application to a newer version. If you've skipped an update to your Amazon WorkSpaces macOS client application and now want to update to the latest version of the client, see Update the WorkSpaces macOS client application to a newer version. My headset doesn't work in my WorkSpace If you're using the Android, iPad, macOS, Linux, or Windows client application for Amazon WorkSpaces, and you're having trouble using your headset in your WorkSpace, try the following steps: 1. Disconnect from your WorkSpace (choose Amazon WorkSpaces, Disconnect WorkSpace). 2. Unplug your headset, and then plug it back in. Verify that it works on your local computer or tablet. For a USB headset, make sure that it shows up as a playback device locally on your computer or tablet: • For Windows, check the devices listed in the Control Panel under Hardware and Sound > Sound. In the Sound dialog box, choose the Playback tab. • For macOS, choose the Apple menu > System Preferences > Sound > Output. • For iPad, open the Control Center and tap the AirPlay button. • For Chromebook, open the system tray, and then choose the headphone icon next to the volume slider. Select the devices that you want to use for audio input and output. 3. Reconnect to your WorkSpace. Your headset should now work in your WorkSpace. If you're still having trouble with your headset, contact your WorkSpaces administrator. I skipped an update to my client application and am having trouble updating my client to the latest version 165 Amazon WorkSpaces Note Audio currently is not supported on Linux WorkSpaces using the DCV. User Guide I am unable to install the Android client application on my Chromebook Version 2.4.13 is the final release of the Amazon WorkSpaces Chromebook client application. Because Google is phasing out support for Chrome Apps, there will be no further updates to the WorkSpaces Chromebook client application, and its use is unsupported. For Chromebooks that support installing Android applications, we recommend using the WorkSpaces Android client application instead. If you are using a Chromebook launched before 2019, see the installation steps for Chromebooks launched before 2019 before attempting to install the Amazon WorkSpaces Android client application. In some cases, your WorkSpaces administrator might need to enable your Chromebook to install Android applications. If you are unable to install the Android client application on your Chromebook, contact your WorkSpaces administrator for assistance. I'm getting the wrong characters when I type; for example, I get \ and | when I try to type quotation marks (' and ") This behavior might occur if your device is not set to the same language as your WorkSpace, or if you're using a language-specific keyboard, such as a French keyboard. To resolve this issue, see Language and keyboard settings for WorkSpaces. The WorkSpaces client application won't run on my Mac If you try to run older versions of the WorkSpaces client application on your Mac, the client application might not start, and you might receive security warnings such as the following: "WorkSpaces.app will damage your computer. You should move it to the Trash." I am unable to install the Android client application on my Chromebook 166 Amazon WorkSpaces User Guide "WorkSpaces.app is damaged and can't be opened. You should move it to the Trash." If you use macOS 10.15 (Catalina) or later, you must use version 3.0.2 or later of the macOS client. Versions 2.5.11 and earlier of the macOS client can no longer be |
workspaces-ug-051 | workspaces-ug.pdf | 51 | older versions of the WorkSpaces client application on your Mac, the client application might not start, and you might receive security warnings such as the following: "WorkSpaces.app will damage your computer. You should move it to the Trash." I am unable to install the Android client application on my Chromebook 166 Amazon WorkSpaces User Guide "WorkSpaces.app is damaged and can't be opened. You should move it to the Trash." If you use macOS 10.15 (Catalina) or later, you must use version 3.0.2 or later of the macOS client. Versions 2.5.11 and earlier of the macOS client can no longer be installed on macOS devices. These versions also no longer work on devices with macOS Catalina or later. If you are using version 2.5.11 or earlier and you upgrade from an older version of macOS to Catalina or later, you will no longer be able to use the 2.5.11 or earlier client. To resolve this issue, we recommend that affected users upgrade to the latest version of the macOS client that is available for download at https://clients.amazonworkspaces.com/ . For more information about installing or updating the macOS client, see Setup and installation. I'm having trouble using the Windows logo key in Windows WorkSpaces when working on a Mac By default, the Windows logo key on a Windows keyboard and the Command key on an Apple keyboard are both mapped to the Ctrl key when you're using the Amazon WorkSpaces macOS client application. If you want to change this behavior so that these two keys are mapped to the Windows logo key, see Remap the Windows logo key or the Command key for instructions on how to remap these keys. My WorkSpace looks blurry on my Mac If your screen resolution in WorkSpaces is low and objects look blurry, you need to turn on high DPI mode and adjust the display scaling settings on your Mac. For more information, see Enabling high DPI display for WorkSpaces. I'm having trouble copying and pasting If you are having trouble copying and pasting, confirm the following to help solve your issue: • Your administrator has enabled clipboard redirection for your WorkSpace. Contact you organization's WorkSpaces administrator or IT department for support. • The uncompressed object size is under the maximum of 20 MB. I'm having trouble using the Windows logo key in Windows WorkSpaces when working on a Mac 167 Amazon WorkSpaces User Guide • The data type that you copied is supported for clipboard redirection. For a list of supported data types, see Understanding HP Anyware Copy/Paste Feature in the Teradici documentation. My screen is flickering or not updating properly, or my mouse isn't clicking in the right place If you're using a version of the Amazon WorkSpaces Windows client application prior to version 3.1.4, you might experience the following screen update issues, caused by hardware acceleration: • The screen might have flickering black boxes in some places. • The screen might not properly update on the WorkSpaces login page, or it might not properly update after you log in to your WorkSpace. You might see artifacts on the screen. • Your mouse clicks might not be lined up with the cursor position on the screen. To address these issues, we recommend upgrading to version 3.1.4 or later of the Windows client application. Starting with version 3.1.4, hardware acceleration is turned off by default in the Windows client application. However, if you need to enable hardware acceleration in version 3.1.4 or later, for example if you're experiencing slow performance when using the client, see Manage hardware acceleration. If you need to use version 3.1.3 or earlier of the Windows client application, you can disable hardware acceleration in Windows. To disable hardware acceleration for version 3.1.3 or earlier, see Managing Hardware Acceleration. Disabling hardware acceleration in Windows might affect the performance of other Windows applications. The WorkSpaces client for Windows prompts to update to a version that is already installed The WorkSpaces client installer for Windows allows users to install the client just for themselves or for all users of the machine. If it's installed for a single user, other users on the same Windows machine will not be able to run the WorkSpaces client application. If it is installed for all users, all users on the same Windows machine will be able to run the application. My screen is flickering or not updating properly, or my mouse isn't clicking in the right place 168 Amazon WorkSpaces User Guide When the WorkSpaces client for Windows is launched, it detects if there is an update and displays a dialog asking the user if they would like to update the application as shown in the following example. Users might continue to see this prompt even after they have updated to the version shown on the prompt. This |
workspaces-ug-052 | workspaces-ug.pdf | 52 | application. If it is installed for all users, all users on the same Windows machine will be able to run the application. My screen is flickering or not updating properly, or my mouse isn't clicking in the right place 168 Amazon WorkSpaces User Guide When the WorkSpaces client for Windows is launched, it detects if there is an update and displays a dialog asking the user if they would like to update the application as shown in the following example. Users might continue to see this prompt even after they have updated to the version shown on the prompt. This is caused by having multiple versions of the WorkSpaces client installed on the same computer. For example, a user might have installed the WorkSpaces client just for themselves, and then later installed a newer version of the client for all users on the same Windows machine. The user will continue to see the update prompt if they continue to open the older version of the client after performing the update. Users should complete one of the following procedures to uninstall the old version of the WorkSpaces client from their computers. This ensures that only the new version of the client is opened next time it's launched. Uninstall an old version of the WorkSpaces client for Windows using the Control Panel 1. Open the Windows start menu. 2. 3. 4. 5. Search for the Control Panel and open it. In the Control Panel, open Programs and Features. In the Uninstall or change a program window, scroll and find the different versions of Amazon WorkSpaces that are installed. Select the older version installed, and choose Uninstall. The installed version number is listed in the Version column. 6. Choose Yes if prompted to confirm the uninstall. The WorkSpaces client for Windows prompts to update to a version that is already installed 169 Amazon WorkSpaces User Guide You might be required to restart your computer when the uninstall completes. Remove the WorkSpaces client for Windows using the client installer 1. Choose Install update if you see the software update prompt when launching the WorkSpaces client application. 2. Choose Next on the Amazon WorkSpaces Setup screen of the installer. The installer will detect if the newer version of the WorkSpaces client is installed, and offer the option to repair or remove it. 3. Choose Remove to uninstall the newer version of the installer. You might be required to restart your computer when the uninstall completes. 4. Launch the WorkSpaces client again and choose Install update when you see the software update prompt. 5. Choose to install the client just for yourself or for all users of the machine. You choice here should be the same choice you made when you originally installed the WorkSpaces client for Windows. This will ensure that you don't see the repeated update prompts next time you launch the client. I don't see video-in devices listed under Devices on my WorkSpaces Windows client You might not have the Media Feature Pack installed on Windows, if you're using certain versions of Windows Operating System, such as Windows N. By default, the Media Feature Pack isn't installed on Windows N. To install it, see Media Feature Pack for N versions of Windows 10, choose Install Instructions, and follow the instructions. I don't see video-in devices listed under Devices on my WorkSpaces Windows client 170 |
workspacescore-ag-001 | workspacescore-ag.pdf | 1 | Administration Guide Amazon WorkSpaces Core Copyright © 2025 Amazon Web Services, Inc. and/or its affiliates. All rights reserved. Amazon WorkSpaces Core Administration Guide Amazon WorkSpaces Core: Administration Guide Copyright © 2025 Amazon Web Services, Inc. and/or its affiliates. All rights reserved. Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be affiliated with, connected to, or sponsored by Amazon. Amazon WorkSpaces Core Table of Contents Administration Guide Administration guides for partner solutions on Amazon WorkSpaces Core ................................ 1 Document history ............................................................................................................................ 2 iii Amazon WorkSpaces Core Administration Guide Administration guides for partner solutions on Amazon WorkSpaces Core Amazon WorkSpaces Core offers managed virtual desktop infrastructure designed to work with third-party management solutions. For more information, see Amazon WorkSpaces Core. Amazon WorkSpaces Core is part of the Amazon WorkSpaces Family of services. Amazon WorkSpaces Core gives technology partners like you flexibility and choice, while maintaining the security, global reliability, and cost efficiency customers have enjoyed from WorkSpaces for years. For more information, see Amazon WorkSpaces Family. If you are an administrator who wants an immediate solution to configuring workspaces, without having to build or develop your own solution with Amazon WorkSpaces Core, please refer to the following administration guides from our partners: • If you want to set up Citrix DaaS on Amazon WorkSpaces Core, see Citrix DaaS for Amazon WorkSpaces Core. • If you want to set up Workspot Cloud PCs with Amazon WorkSpaces Core, see Getting Started with Workspot. • If you want to set up Leostream with Amazon WorkSpaces Core, see Using Leostream to Manage Amazon WorkSpaces Core. • If you want to set up VMware Horizon with Amazon WorkSpaces Core, see Extending VMware Horizon to Amazon WorkSpaces Core. 1 Amazon WorkSpaces Core Administration Guide Document history for the Amazon WorkSpaces Core Administration Guide The following table describes the documentation releases for Amazon WorkSpaces Core. Change Description Date New and updated link Added link to Citrix Daas and updated Workspot link April 1, 2024 Initial release Initial release of the Amazon WorkSpaces Core Administr ation Guide September 20, 2023 2 |
workspacescore-pg-001 | workspacescore-pg.pdf | 1 | Technology Partner Integration Guide Amazon WorkSpaces Core Copyright © 2025 Amazon Web Services, Inc. and/or its affiliates. All rights reserved. Amazon WorkSpaces Core Technology Partner Integration Guide Amazon WorkSpaces Core: Technology Partner Integration Guide Copyright © 2025 Amazon Web Services, Inc. and/or its affiliates. All rights reserved. Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be affiliated with, connected to, or sponsored by Amazon. Amazon WorkSpaces Core Technology Partner Integration Guide Table of Contents Introduction ..................................................................................................................................... 1 Shared responsibility model ........................................................................................................... 2 Shared responsibilities with Amazon WorkSpaces Core ....................................................................... 2 Amazon WorkSpaces Core responsibilities .............................................................................................. 2 Customer and partner responsibilities ..................................................................................................... 3 Prerequisites ..................................................................................................................................... 5 Infrastructure setup ......................................................................................................................... 6 Enable AWS account for Bring Your Own Protocol ............................................................................... 6 Grant partner solution access to AWS account ...................................................................................... 6 Enable the account for BYOL and configure the BYOL CIDR block (Windows client OS ONLY) .............................................................................................................................................................. 7 Import the Windows Client OS image (BYOL-BYOP) ............................................................................ 7 Configure the directory ............................................................................................................................... 8 Add a security group to a WorkSpaces directory .................................................................................. 9 Deploy Amazon WorkSpaces Core desktops ........................................................................................... 9 Custom images ........................................................................................................................................... 11 Tag-based authorization guidelines ............................................................................................. 12 Tag conditions ............................................................................................................................................. 12 TagKeys condition ................................................................................................................................. 12 RequestTag condition ........................................................................................................................... 12 ResourceTag condition ......................................................................................................................... 13 Additional examples .................................................................................................................................. 14 Lifecycle management of instances ............................................................................................. 16 Solution deployment guide example ........................................................................................... 18 Document history .......................................................................................................................... 20 iii Amazon WorkSpaces Core Technology Partner Integration Guide Introduction Amazon WorkSpaces Core offers managed virtual desktop infrastructure (VDI) that's designed to work with third-party management solutions. Amazon WorkSpaces Core gives technology partners like you flexibility and choice, while maintaining the security, global reliability, and cost efficiency customers have enjoyed from WorkSpaces for years. For more information, see Amazon WorkSpaces Core. Amazon WorkSpaces Core is part of the Amazon WorkSpaces Family of services. For more information, see Amazon WorkSpaces Family. This guide is for third-party VDI solution providers who want to build a solution using Amazon WorkSpaces Core. Amazon WorkSpaces Core is for builders. Builders use Amazon WorkSpaces Core API operations to easily provide WorkSpaces capabilities in their solutions with select, purpose- built infrastructure components. If you're a customer interested in using a VDI or desktop as a service (DaaS) solution built on Amazon WorkSpaces Core, see Amazon WorkSpaces Core and choose WorkSpaces Core Partners to learn more. 1 Amazon WorkSpaces Core Technology Partner Integration Guide Shared responsibility model Security and compliance is a shared responsibility between AWS and its partners. This shared model can help relieve your operational burden. AWS operates, manages and controls the components from the host operating system and visualization layer to the physical security of the facilities in which the service operates. The customer assumes responsibility and management of the guest operating system (including updates and security patches), other associated application software, and the configuration of the security group firewall that's provided by AWS. Customers should carefully consider the services that they choose. Their responsibilities vary depending on the services used, the integration of those services into their IT environment, and applicable laws and regulations. The nature of this shared responsibility also provides the flexibility and customer control that permits the deployment. For more information, see Shared Responsibility Model. Topics • Shared responsibilities with Amazon WorkSpaces Core • Amazon WorkSpaces Core responsibilities • Customer and partner responsibilities Shared responsibilities with Amazon WorkSpaces Core The following responsibilities are shared between your company and Amazon WorkSpaces Core: • Compliance validation. • Amazon WorkSpaces image import. • AWS Identity and Access Management (IAM) for WorkSpaces. This responsibility includes IAM configurations and policies. This responsibility doesn't include access to the desktop through the customer and/or partner directory, or gateway services. Amazon WorkSpaces Core responsibilities The following responsibilities belong to Amazon WorkSpaces Core: • Infrastructure security. Shared responsibilities with Amazon WorkSpaces Core 2 Amazon WorkSpaces Core Technology Partner Integration Guide • Encryption at rest (which must be enabled). For more information, see Encrypted WorkSpaces in the Amazon WorkSpaces Administration Guide. • Resilience in Amazon WorkSpaces Core (except for cross-Region redirection). • WorkSpaces API operations, AWS Command Line Interface (AWS CLI), SDK, CDK, and console. • WorkSpaces based monitoring. • WorkSpaces dedicated hardware requirements. • Windows operating system (OS) updates and security patches. Customer and partner responsibilities The following responsibilities belong to your company: • Lifecycle of the Amazon WorkSpaces Core desktop, including calling our API, CLI, or console to provision the desktop, receiving any status, and calling our API, CLI, or console to terminate the desktop. • Registration of Amazon WorkSpaces Core desktops within the customer or partner solution. |
workspacescore-pg-002 | workspacescore-pg.pdf | 2 | Guide. • Resilience in Amazon WorkSpaces Core (except for cross-Region redirection). • WorkSpaces API operations, AWS Command Line Interface (AWS CLI), SDK, CDK, and console. • WorkSpaces based monitoring. • WorkSpaces dedicated hardware requirements. • Windows operating system (OS) updates and security patches. Customer and partner responsibilities The following responsibilities belong to your company: • Lifecycle of the Amazon WorkSpaces Core desktop, including calling our API, CLI, or console to provision the desktop, receiving any status, and calling our API, CLI, or console to terminate the desktop. • Registration of Amazon WorkSpaces Core desktops within the customer or partner solution. • Brokering Active Directory users to the Amazon WorkSpaces Core desktop. • Gateway services for securely accessing the Amazon WorkSpaces Core desktop. • Multi-Region resilience. • AWS is responsible for patching and fixing flaws within the infrastructure, but customers are responsible for patching their guest OS and applications. • Additional monitoring, security, and analytic solutions. These solutions are also the responsibility of the customer or partner operating the solution. The following images show the shared responsibility model and shared responsibility with AWS and your partner. Customer and partner responsibilities 3 Amazon WorkSpaces Core Technology Partner Integration Guide Customer and partner responsibilities 4 Amazon WorkSpaces Core Technology Partner Integration Guide Prerequisites To use an Amazon WorkSpaces Core-based virtual desktop infrastructure (VDI) solution, customers must meet the following requirements: • The customer must have a technology partner that they're working with, or be willing to build their own control plane (broker and orchestration). They must also bring their own pixel streaming protocol. • The customer must have Active Directory (AD connector or MAD within a customer account). • If the customer is deploying Windows Client OS then the customer must meet the Bring Your Own License model (BYOL) criteria. For more information, see Bring Your Own Windows desktop licenses in the Amazon WorkSpaces Administration Guide. • If the customer is deploying Windows Server OS then the customer will need to provide Remote desktop licensing. • Windows Server license included for Amazon WorkSpaces Core instances include two Microsoft Remote Desktop connections for administrative purposes only. If you need additional Microsoft Remote Desktop connections, you can buy Remote Desktop Services User CALs with Software Assurance (SA) from Microsoft and bring them to AWS through License Mobility benefits. • If you have Microsoft Software Assurance with License Mobility, you might be able to bring your own Microsoft RDS CALs and then use them with Amazon WorkSpaces Core. For more information about how to sign up for and complete a license verification process, and to view eligibility requirements, see License Mobility. • First, sign up and complete the Microsoft license verification form to confirm that you have eligible licenses with Software Assurance. For more information, see License Mobility through Software Assurance on the Microsoft website. In the License Mobility Verification form, provide the following information about the Authorized Mobility Partner: • Email Address: microsoft@amazon.com • Partner Name: Amazon Web Services • Partner Website: aws.amazon.com • After the form is submitted, Microsoft provides confirmation to you and to Amazon Web Services (AWS) that you have completed the verification process. For more information, see Microsoft licensing on AWS. 5 Amazon WorkSpaces Core Technology Partner Integration Guide Infrastructure setup Use the following steps to set up your customer’s AWS account. As the technology partner, you perform some steps, and your customer also performs some steps. Topics • Enable AWS account for Bring Your Own Protocol • Grant partner solution access to AWS account • Enable the account for BYOL and configure the BYOL CIDR block (Windows client OS ONLY) • Import the Windows Client OS image (BYOL-BYOP) • Configure the directory • Add a security group to a WorkSpaces directory • Deploy Amazon WorkSpaces Core desktops • Custom images Enable AWS account for Bring Your Own Protocol To enable the customer AWS account for BYOP, customers must contact their AWS account manager. For select technology partners with hosted managed solutions, BYOP might be enabled at the technology partner solution level. In that case, the customer account won't need to have BYOP enabled within their account. Grant partner solution access to AWS account Partner step and Customer step – Create a technology partner solution connection to the customer's AWS account. For more information, see AWS security credentials in the IAM User Guide. This connection can be done with secret and access keys for self-managed solutions. The preferred method is to use an assume role capability. For more information, see How to Use External ID When Granting Access to Your AWS Resources at the AWS Security Blog. If assume role access is being used, the technology partner creates an assume role from the technology partner solution's AWS account to the customer's AWS account. You can provide the Enable AWS account for |
workspacescore-pg-003 | workspacescore-pg.pdf | 3 | a technology partner solution connection to the customer's AWS account. For more information, see AWS security credentials in the IAM User Guide. This connection can be done with secret and access keys for self-managed solutions. The preferred method is to use an assume role capability. For more information, see How to Use External ID When Granting Access to Your AWS Resources at the AWS Security Blog. If assume role access is being used, the technology partner creates an assume role from the technology partner solution's AWS account to the customer's AWS account. You can provide the Enable AWS account for Bring Your Own Protocol 6 Amazon WorkSpaces Core Technology Partner Integration Guide customer with an AWS CloudFormation template to automate creation of the role with permissions or instructions on permissions as needed. If assume role access is being used, instruct your customer to use tag-based authorization. This limits exposure to customer resources from the role granted to the partner solution. For more information, see Tag-based authorization guidelines. Enable the account for BYOL and configure the BYOL CIDR block (Windows client OS ONLY) Follow these steps to enable Bring Your Own Licenses (BYOL), configure the BYOL Classless Inter- Domain Routing (CIDR) block, and register the directory. 1. (Customer step) – Enable BYOL. a. For information on how to enable BYOL see Bring Your Own Windows desktop licenses in the Amazon WorkSpaces Administration Guide. 2. (Partner step) – List and configure the management CIDR ranges. a. This is the management CIDR block that is required for the WorkSpaces dedicated control plane. WorkSpaces desktops have two elastic network interfaces: one network interface for the management network and another for access to a customer's virtual private cloud (VPC). First use the DescribeAccountModifications API to see if the customer has configured the CIDR block already. If they haven't, use the ListAvailableManagementCidrRanges API to provide a list of CIDR block ranges for the customer to select. Then use the ModifyAccount API to configure BYOL and provide the CIDR block. Important This action can not be changed once configured. Import the Windows Client OS image (BYOL-BYOP) Use the following steps to import the image. Enable the account for BYOL and configure the BYOL CIDR block (Windows client OS ONLY) 7 Amazon WorkSpaces Core Technology Partner Integration Guide 1. (Customer step) – The customer must have an image within Amazon Elastic Compute Cloud (Amazon EC2) as an Amazon Machine Image (AMI). For more information, see Importing a VM as an image using VM Import/Export in the VM Import/Export User Guide. 2. (Partner step) – List the AMIs and display them to the customer admin by using the DescribeImages API. describe-images - (EC2) "VirtualizationType" (filter) "Description" (display) "PlatformDetails" (display) "EnaSupport" (display) - instance types limit "Hypervisor" (display) - instance types limit "State" (filter) "ImageId" (display) "VolumeType" (display) "VolumeSize" (display) - make sure meets WS requirements "Encrypted" (display and filter) not supported "OwnerId" (display) "ImageType": "machine" (filter) "Name" (display) 3. (Customer step) – Select the Amazon EC2 AMI. 4. (Partner step) – Import the image. Make sure to use the BYOP import ingestion process with the ImportWorkspaceImage Amazon WorkSpaces Core API. When doing so, choose an ingestion process option that meets your needs. For more information about the ingestion process options available, see IngestionProcess in the WorkSpaces API Reference. Following is an example command using the AWS CLI: aws workspaces import-workspace-image --ec2-image-id ami-example123 --ingestion- process BYOL_REGULAR_BYOP --image-name win10-ent-img01 --image-description “Windows 10 Enterprise” 5. (Partner step) – Display the status of the import by using the DescribeWorkspaceImages API. Configure the directory Complete the following steps to configure the directory. Configure the directory 8 Amazon WorkSpaces Core Technology Partner Integration Guide 1. (Partner step) – Present the directories that the customer admin would choose for WorkSpaces using the DescribeWorkspaceDirectories API. Amazon WorkSpaces requires that you pre- configure a directory within the AWS Directory Service. 2. (Partner step) – Register the directory to AWS for this WorkSpaces to access using the RegisterWorkspaceDirectory API. This step is used for adding the desktop to Active Directory. Note that BYOL requires a tenancy of DEDICATED, all others must use SHARED Add a security group to a WorkSpaces directory You must allow for access from the customer VPC into the Amazon WorkSpaces Core desktop. WorkSpaces desktops, including Amazon WorkSpaces Core desktops, have a security group attached to the customer VPC elastic network interface. By default, this security group blocks all traffic. For Remote Desktop Protocol (RDP) access or access from any other protocol that will be accessing the desktop, you must add or modify a security group to the WorkSpaces directory. For more information, see Security groups for your WorkSpaces in the Amazon WorkSpaces Administration Guide. You can also add this new default security group to existing WorkSpaces without rebuilding them. For more information, see To add |
workspacescore-pg-004 | workspacescore-pg.pdf | 4 | VPC into the Amazon WorkSpaces Core desktop. WorkSpaces desktops, including Amazon WorkSpaces Core desktops, have a security group attached to the customer VPC elastic network interface. By default, this security group blocks all traffic. For Remote Desktop Protocol (RDP) access or access from any other protocol that will be accessing the desktop, you must add or modify a security group to the WorkSpaces directory. For more information, see Security groups for your WorkSpaces in the Amazon WorkSpaces Administration Guide. You can also add this new default security group to existing WorkSpaces without rebuilding them. For more information, see To add a security group to an existing WorkSpace in the Amazon WorkSpaces Administration Guide. Use caution when modifying or deleting these security groups. Customers are responsible for the “security in the cloud." For more information, see Shared Responsibility Model. Deploy Amazon WorkSpaces Core desktops Complete the following steps to deploy the Amazon WorkSpaces Core desktops. 1. (Partner and customer step) – Create a bundle using the CreateWorkspaceBundle API. Initially only needed for BYOL deployments. BYOL customers import their image first. They will need to create a bundle to deploy desktops. Unlike shared tenancy deployments where WorkSpaces provides a bundle which includes an image. CreateWorkspaceBundle (Amazon WorkSpaces) "BundleDescription" "BundleName" Add a security group to a WorkSpaces directory 9 Amazon WorkSpaces Core Technology Partner Integration Guide "ComputeType" "ImageId" "RootStorage" - "Capacity" "Tags": [ "UserStorage" "Capacity" 2. (Partner and customer step) – Create a WorkSpace using the CreateWorkspaces API. Note Amazon WorkSpaces Core (BYOP) supports user-decoupled and regular user-assigned WorkSpaces. Following is an example command using the AWS CLI: aws workspaces create-workspaces --workspaces DirectoryId=d- example123,UserName='"[UNDEFINED]"',WorkspaceName=desktop1,BundleId=wsb-example123 For RunningMode, the AUTO_STOP mode isn't available for Amazon WorkSpaces Core. Instead, a new running mode value of MANUAL is available for technology partner solutions to power manage the workspace and offer hourly usage of the instance. With the MANUAL mode, technology partner solutions use the StartWorkSpaces and StopWorkSpaces API operations to manage the workspaces. The customer is only charged for the hours when the WorkSpace is in the AVAILABLE state. Note To ensure that no workspaces are inadvertently charging the customer for unknown periods of time, manual workspaces in the AVAILABLE state will be stopped after a sufficiently long period of time (greater than or equal to 48 hours). Manual workspaces are subject to an automatic maintenance window schedule once a month, similar to the current AUTO_STOP workspaces detailed here. You can opt out of this maintenance schedule by using the ModifyWorkspaceCreationProperties API operation. Deploy Amazon WorkSpaces Core desktops 10 Amazon WorkSpaces Core Custom images Technology Partner Integration Guide After you deploy a WorkSpace, you can customize the image being used by customers moving forward. For example, if you use a shared tenancy bundle for BYOP and you’d like to install a partner solution agent, or install productivity or proprietary applications within an image. This is often referred to as golden image creation. You can customize an image using the CreateWorkspaceImage API. You can then use use the CreateWorkspaceBundle or UpdateWorkspaceBundle API. Then deploy WorkSpaces as described within this document. Custom images 11 Amazon WorkSpaces Core Technology Partner Integration Guide Tag-based authorization guidelines Tag-based authorization can prevent you from modifying customer resources. This strategy utilizes IAM tag conditions. You assume a role in your customer’s account, and the role will have IAM policies based on tag conditions. When you create a resource in your customer’s account, the policy requires a specific tag to be added. And when you modify a resource in your customer’s account, the policy ensures that it only allows modification on resources with the specified tags. You should not have permission to modify or delete tags on a resource. To create a complete IAM policy for the assume role, the customer can use the following examples. Topics • Tag conditions • Additional examples Tag conditions TagKeys condition To ensure that only a specific tag key can be used in a request, use the aws:TagKeys condition key. RequestTag condition To ensure that a specific tag key and value will be put on the resource, use a combination of the aws:TagKeys and aws:RequestTag condition keys. This applies to resource creation API actions, such as CreateWorkspaces. The following tag keys policy example only allows API actions to use tag keys “PartnerManaged.” { "Version":"2012-10-17", "Statement":[ { "Effect":"Allow", "Action":[ ws:CreateWorkspaces Tag conditions 12 Technology Partner Integration Guide Amazon WorkSpaces Core ], "Resource":"*", "Condition":{ "StringEquals": { "aws:RequestTag/PartnerManaged": "true" }, "ForAllValues:StringEquals": { "aws:TagKeys": "PartnerManaged" } } } ] } ResourceTag condition To control access to a customer’s resources based on the tag key and value use a combination of the aws:TagKeys and aws:ResourceTag condition keys. This applies to modifications related to API actions, such as ModifyWorkspaceProperties. The following resource tag policy example ensures that modifications can only happen on resources with the |
workspacescore-pg-005 | workspacescore-pg.pdf | 5 | tag keys policy example only allows API actions to use tag keys “PartnerManaged.” { "Version":"2012-10-17", "Statement":[ { "Effect":"Allow", "Action":[ ws:CreateWorkspaces Tag conditions 12 Technology Partner Integration Guide Amazon WorkSpaces Core ], "Resource":"*", "Condition":{ "StringEquals": { "aws:RequestTag/PartnerManaged": "true" }, "ForAllValues:StringEquals": { "aws:TagKeys": "PartnerManaged" } } } ] } ResourceTag condition To control access to a customer’s resources based on the tag key and value use a combination of the aws:TagKeys and aws:ResourceTag condition keys. This applies to modifications related to API actions, such as ModifyWorkspaceProperties. The following resource tag policy example ensures that modifications can only happen on resources with the tag “Key=PartnerManaged, Value=true”. { "Version":"2012-10-17", "Statement":[ { "Effect":"Allow", "Action":[ ws:ModifyWorkspaceProperties ], "Resource":"*", "Condition":{ "StringEquals":{ "aws:ResourceTag/PartnerManaged":"true" }, "ForAllValues:StringEquals": { "aws:TagKeys": "PartnerManaged" } } } ResourceTag condition 13 Amazon WorkSpaces Core Technology Partner Integration Guide ] } Additional examples API name Tag condition request Assumed role policy for UserTag Note CreateWorkSpaces TagKeys + RequestTa g TerminateWorkSpace s TagKeys + RequestTa g { "Version":"2012- 10-17", "Statement":[ { "Effect":"Allow" , "Action":[ "workspaces:Cr eateWorkspaces" ], "Resource":"*", "Condition":{ "StringEquals": { "aws:RequestTag /PartnerM anaged":"tru e" }, "ForAllV alues:Str ingEquals":{ "aws:TagKeys": "PartnerM anaged" } } } ] } { With this policy, you can only create a workspace if you provide a tag key "PartnerManaged" and value "true" in the request. With this policy, you can only terminate Additional examples 14 Amazon WorkSpaces Core API name Technology Partner Integration Guide Tag condition request Assumed role policy for UserTag Note "Version":"2012- a workspace if the workspace has a tag key "PartnerM anaged" and value "true". 10-17", "Statement":[ { "Effect":"Al low", "Action":[ "workspace s:Termina teWorkspaces" ], "Resource":"*", "Condition":{ "StringEquals": { "aws:Res ourceTag/ PartnerMa naged":"tr ue" }, "ForAllVa lues:Stri ngEquals":{ "aws:TagKeys":" PartnerManaged" } } } ] } Additional examples 15 Amazon WorkSpaces Core Technology Partner Integration Guide Lifecycle management of instances To perform various actions for Amazon WorkSpaces Core, use the following API operations. To help you create your workflow, we have provided a recommendation for each API operation. We recommend partners solutions use as many of these APIs as possible so that admin customers don’t need to access the WorkSpaces console. • Deployment and setup • CreateTags • DescribeAccount • DescribeAccountModifications • ImportWorkspaceImage • ModifyAccount • ListAvailableManagementCidrRanges • RegisterWorkspaceDirectory • Operations • CopyWorkspaceImage – Supports an UpdateWorkspaceBundle image process and copying from one AWS Region to another Region. • CreateWorkspaceImage – Supports custom images and workflows for day-two operations. • DescribeTags • DescribeWorkspaceBundles • DescribeWorkspaceDirectories • DescribeWorkspaceImagePermissions • DescribeWorkspaceImages • DescribeWorkspaces • DescribeWorkspaceSnapshots • MigrateWorkspace • ModifyWorkspaceCreationProperties • ModifyWorkspaceProperties – Supports modification of the following properties: • ComputeTypeName • RootVolumeSizeGib • RunningMode – BYOP must use ALWAYS_ON or MANUAL. 16 Amazon WorkSpaces Core Technology Partner Integration Guide • UserVolumeSizeGib • ModifyWorkspaceState • RebootWorkspaces • RebuildWorkspaces • RestoreWorkspace • StartWorkspaces • StopWorkspaces • UpdateWorkspaceBundle • UpdateWorkspaceImagePermission • Termination • DeleteTags • DeleteWorkspaceBundle • DeleteWorkspaceImage • DeregisterWorkspaceDirectory • TerminateWorkspaces 17 Amazon WorkSpaces Core Technology Partner Integration Guide Solution deployment guide example As a partner who is building a solution using Amazon WorkSpaces Core, it's your responsibility to document how your customers can deploy your solution to their environments. We recommend that you create a deployment guide, with the following suggested table of contents. Some topics might not be relevant to your solution, so revise the topics as necessary. It’s also a good practice to link to other AWS documentation where relevant. For example, refer your customers to the Amazon WorkSpaces Administration Guide for sections related to Bring Your Own License (BYOL) image import, directory setup, and virtual private cloud (VPC) setup. Specific details of your deployment guide and steps will vary, depending on the level of integration of your solution with the WorkSpaces API, and what steps customers must take manually using the AWS Management Console or AWS Command Line Interface. As a partner, you're responsible for hosting and publishing the deployment guides on your website. Amazon WorkSpaces Core can link to these guides from the WorkSpaces Core Partners section at Amazon WorkSpaces Core, where customers can easily find them. Following is a suggested table of contents for an Amazon WorkSpaces Core solution deployment guide: • Chapter 1: Introduction • Chapter 2: Getting started • Overview • Setting up security groups • Configuring the directory services security group • Configuring a VPC • Chapter 3: Installing <your service> in Amazon EC2 • Required AWS permissions • Launching a connection broker instance • Upgrading the <your service> connection broker • Lauching a <your service> gateway instance • Obtaining your <your service> license • Chapter 4: Preparing WorkSpaces Core images • Chapter 5: Integrating with your AWS infrastructure 18 Amazon WorkSpaces Core Technology Partner Integration Guide • Connecting to your Amazon diretory services • Connecting to your Amazon WorkSpaces account • Attaching the <your service> gateway to a connection broker • Chapter 6: Launching |
workspacescore-pg-006 | workspacescore-pg.pdf | 6 | Configuring the directory services security group • Configuring a VPC • Chapter 3: Installing <your service> in Amazon EC2 • Required AWS permissions • Launching a connection broker instance • Upgrading the <your service> connection broker • Lauching a <your service> gateway instance • Obtaining your <your service> license • Chapter 4: Preparing WorkSpaces Core images • Chapter 5: Integrating with your AWS infrastructure 18 Amazon WorkSpaces Core Technology Partner Integration Guide • Connecting to your Amazon diretory services • Connecting to your Amazon WorkSpaces account • Attaching the <your service> gateway to a connection broker • Chapter 6: Launching new workspaces • Loading users • Deploying new workspaces • Chapter 7: Connecting users to WorkSpaces • Amazon WorkSpaces pools • Protocol plans • Power control plans • Release plans • Building user policies • Assigning policies to users • Testing your connection broker configuration • Connecting to WorkSpaces 19 Amazon WorkSpaces Core Technology Partner Integration Guide Document history for the Amazon WorkSpaces Core Technology Partner Integration Guide The following table describes the documentation releases for Amazon WorkSpaces Core. Change Description Date Added new topic Initial release Added "Tag-based authoriza tion guidelines" topic April 1, 2024 Initial release of the Amazon WorkSpaces Core Technology Partner Integration Guide. September 20, 2023 20 |
workspacesweb-api-001 | workspacesweb-api.pdf | 1 | API Reference Amazon WorkSpaces Secure Browser API Version 2020-07-08 Copyright © 2025 Amazon Web Services, Inc. and/or its affiliates. All rights reserved. Amazon WorkSpaces Secure Browser API Reference Amazon WorkSpaces Secure Browser: API Reference Copyright © 2025 Amazon Web Services, Inc. and/or its affiliates. All rights reserved. Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be affiliated with, connected to, or sponsored by Amazon. Amazon WorkSpaces Secure Browser Table of Contents API Reference Welcome ........................................................................................................................................... 1 Actions .............................................................................................................................................. 2 AssociateBrowserSettings ........................................................................................................................... 5 Request Syntax ........................................................................................................................................ 5 URI Request Parameters ........................................................................................................................ 5 Request Body ........................................................................................................................................... 5 Response Syntax ...................................................................................................................................... 5 Response Elements ................................................................................................................................. 6 Errors .......................................................................................................................................................... 6 See Also ..................................................................................................................................................... 7 AssociateDataProtectionSettings ............................................................................................................... 9 Request Syntax ........................................................................................................................................ 9 URI Request Parameters ........................................................................................................................ 9 Request Body ........................................................................................................................................... 9 Response Syntax ...................................................................................................................................... 9 Response Elements ............................................................................................................................... 10 Errors ....................................................................................................................................................... 10 See Also .................................................................................................................................................. 11 AssociateIpAccessSettings ........................................................................................................................ 13 Request Syntax ...................................................................................................................................... 13 URI Request Parameters ...................................................................................................................... 13 Request Body ......................................................................................................................................... 13 Response Syntax ................................................................................................................................... 13 Response Elements ............................................................................................................................... 14 Errors ....................................................................................................................................................... 14 See Also .................................................................................................................................................. 15 AssociateNetworkSettings ........................................................................................................................ 17 Request Syntax ...................................................................................................................................... 17 URI Request Parameters ...................................................................................................................... 17 Request Body ......................................................................................................................................... 17 Response Syntax ................................................................................................................................... 17 Response Elements ............................................................................................................................... 18 Errors ....................................................................................................................................................... 18 See Also .................................................................................................................................................. 19 API Version 2020-07-08 iii Amazon WorkSpaces Secure Browser API Reference AssociateTrustStore .................................................................................................................................... 21 Request Syntax ...................................................................................................................................... 21 URI Request Parameters ...................................................................................................................... 21 Request Body ......................................................................................................................................... 21 Response Syntax ................................................................................................................................... 21 Response Elements ............................................................................................................................... 22 Errors ....................................................................................................................................................... 22 See Also .................................................................................................................................................. 23 AssociateUserAccessLoggingSettings ..................................................................................................... 25 Request Syntax ...................................................................................................................................... 25 URI Request Parameters ...................................................................................................................... 25 Request Body ......................................................................................................................................... 25 Response Syntax ................................................................................................................................... 25 Response Elements ............................................................................................................................... 26 Errors ....................................................................................................................................................... 26 See Also .................................................................................................................................................. 27 AssociateUserSettings ............................................................................................................................... 29 Request Syntax ...................................................................................................................................... 29 URI Request Parameters ...................................................................................................................... 29 Request Body ......................................................................................................................................... 29 Response Syntax ................................................................................................................................... 29 Response Elements ............................................................................................................................... 30 Errors ....................................................................................................................................................... 30 See Also .................................................................................................................................................. 31 CreateBrowserSettings .............................................................................................................................. 33 Request Syntax ...................................................................................................................................... 33 URI Request Parameters ...................................................................................................................... 33 Request Body ......................................................................................................................................... 33 Response Syntax ................................................................................................................................... 35 Response Elements ............................................................................................................................... 35 Errors ....................................................................................................................................................... 35 See Also .................................................................................................................................................. 36 CreateDataProtectionSettings ................................................................................................................. 38 Request Syntax ...................................................................................................................................... 38 URI Request Parameters ...................................................................................................................... 39 Request Body ......................................................................................................................................... 39 API Version 2020-07-08 iv Amazon WorkSpaces Secure Browser API Reference Response Syntax ................................................................................................................................... 41 Response Elements ............................................................................................................................... 41 Errors ....................................................................................................................................................... 41 See Also .................................................................................................................................................. 42 CreateIdentityProvider .............................................................................................................................. 44 Request Syntax ...................................................................................................................................... 44 URI Request Parameters ...................................................................................................................... 44 Request Body ......................................................................................................................................... 44 Response Syntax ................................................................................................................................... 47 Response Elements ............................................................................................................................... 47 Errors ....................................................................................................................................................... 48 See Also .................................................................................................................................................. 49 CreateIpAccessSettings .............................................................................................................................. 50 Request Syntax ...................................................................................................................................... 50 URI Request Parameters ...................................................................................................................... 50 Request Body ......................................................................................................................................... 50 Response Syntax ................................................................................................................................... 52 Response Elements ............................................................................................................................... 53 Errors ....................................................................................................................................................... 53 See Also .................................................................................................................................................. 54 CreateNetworkSettings ............................................................................................................................. 55 Request Syntax ...................................................................................................................................... 55 URI Request Parameters ...................................................................................................................... 55 Request Body ......................................................................................................................................... 55 Response Syntax ................................................................................................................................... 57 Response Elements ............................................................................................................................... 57 Errors ....................................................................................................................................................... 57 See Also .................................................................................................................................................. 58 CreatePortal ................................................................................................................................................. 60 Request Syntax ...................................................................................................................................... 60 URI Request Parameters ...................................................................................................................... 60 Request Body ......................................................................................................................................... 60 Response Syntax ................................................................................................................................... 63 Response Elements ............................................................................................................................... 63 Errors ....................................................................................................................................................... 63 See Also .................................................................................................................................................. 64 API Version 2020-07-08 v Amazon WorkSpaces Secure Browser API Reference CreateTrustStore ......................................................................................................................................... 66 Request Syntax ...................................................................................................................................... 66 URI Request Parameters ...................................................................................................................... 66 Request Body ......................................................................................................................................... 66 Response Syntax ................................................................................................................................... 67 Response Elements ............................................................................................................................... 67 Errors ....................................................................................................................................................... 68 See Also .................................................................................................................................................. 69 CreateUserAccessLoggingSettings .......................................................................................................... 70 Request Syntax ...................................................................................................................................... 70 URI Request Parameters ...................................................................................................................... 70 Request Body ......................................................................................................................................... 70 Response Syntax ................................................................................................................................... 71 Response Elements ............................................................................................................................... 71 Errors ....................................................................................................................................................... 72 See Also .................................................................................................................................................. 73 CreateUserSettings ..................................................................................................................................... 74 Request Syntax ...................................................................................................................................... 74 URI Request Parameters ...................................................................................................................... 75 Request Body ......................................................................................................................................... 75 Response Syntax ................................................................................................................................... 78 Response Elements ............................................................................................................................... 79 Errors ....................................................................................................................................................... 79 See Also .................................................................................................................................................. 80 DeleteBrowserSettings .............................................................................................................................. 81 Request Syntax ...................................................................................................................................... 81 URI Request Parameters ...................................................................................................................... 81 Request Body ......................................................................................................................................... 81 Response Syntax ................................................................................................................................... 81 Response Elements ............................................................................................................................... 81 Errors ....................................................................................................................................................... 81 See Also .................................................................................................................................................. 82 DeleteDataProtectionSettings ................................................................................................................. 84 Request Syntax ...................................................................................................................................... 84 URI Request Parameters ...................................................................................................................... 84 Request Body ......................................................................................................................................... 84 API Version 2020-07-08 vi Amazon WorkSpaces Secure Browser API Reference Response Syntax ................................................................................................................................... 84 Response Elements ............................................................................................................................... 84 Errors ....................................................................................................................................................... 84 See Also .................................................................................................................................................. 85 DeleteIdentityProvider .............................................................................................................................. 87 Request Syntax ...................................................................................................................................... 87 URI Request Parameters ...................................................................................................................... 87 Request Body ......................................................................................................................................... 87 Response Syntax ................................................................................................................................... 87 Response Elements ............................................................................................................................... 87 Errors ....................................................................................................................................................... 87 See Also .................................................................................................................................................. 88 DeleteIpAccessSettings .............................................................................................................................. 90 Request Syntax ...................................................................................................................................... 90 URI Request Parameters ...................................................................................................................... 90 Request Body ......................................................................................................................................... 90 Response Syntax ................................................................................................................................... 90 Response Elements ............................................................................................................................... 90 Errors ....................................................................................................................................................... 90 See Also .................................................................................................................................................. 91 DeleteNetworkSettings ............................................................................................................................. 93 Request Syntax ...................................................................................................................................... 93 URI Request Parameters |
workspacesweb-api-002 | workspacesweb-api.pdf | 2 | Body ......................................................................................................................................... 84 API Version 2020-07-08 vi Amazon WorkSpaces Secure Browser API Reference Response Syntax ................................................................................................................................... 84 Response Elements ............................................................................................................................... 84 Errors ....................................................................................................................................................... 84 See Also .................................................................................................................................................. 85 DeleteIdentityProvider .............................................................................................................................. 87 Request Syntax ...................................................................................................................................... 87 URI Request Parameters ...................................................................................................................... 87 Request Body ......................................................................................................................................... 87 Response Syntax ................................................................................................................................... 87 Response Elements ............................................................................................................................... 87 Errors ....................................................................................................................................................... 87 See Also .................................................................................................................................................. 88 DeleteIpAccessSettings .............................................................................................................................. 90 Request Syntax ...................................................................................................................................... 90 URI Request Parameters ...................................................................................................................... 90 Request Body ......................................................................................................................................... 90 Response Syntax ................................................................................................................................... 90 Response Elements ............................................................................................................................... 90 Errors ....................................................................................................................................................... 90 See Also .................................................................................................................................................. 91 DeleteNetworkSettings ............................................................................................................................. 93 Request Syntax ...................................................................................................................................... 93 URI Request Parameters ...................................................................................................................... 93 Request Body ......................................................................................................................................... 93 Response Syntax ................................................................................................................................... 93 Response Elements ............................................................................................................................... 93 Errors ....................................................................................................................................................... 93 See Also .................................................................................................................................................. 94 DeletePortal ................................................................................................................................................. 96 Request Syntax ...................................................................................................................................... 96 URI Request Parameters ...................................................................................................................... 96 Request Body ......................................................................................................................................... 96 Response Syntax ................................................................................................................................... 96 Response Elements ............................................................................................................................... 96 Errors ....................................................................................................................................................... 96 See Also .................................................................................................................................................. 97 API Version 2020-07-08 vii Amazon WorkSpaces Secure Browser API Reference DeleteTrustStore ......................................................................................................................................... 99 Request Syntax ...................................................................................................................................... 99 URI Request Parameters ...................................................................................................................... 99 Request Body ......................................................................................................................................... 99 Response Syntax ................................................................................................................................... 99 Response Elements ............................................................................................................................... 99 Errors ....................................................................................................................................................... 99 See Also ................................................................................................................................................ 100 DeleteUserAccessLoggingSettings ........................................................................................................ 102 Request Syntax .................................................................................................................................... 102 URI Request Parameters ................................................................................................................... 102 Request Body ....................................................................................................................................... 102 Response Syntax ................................................................................................................................. 102 Response Elements ............................................................................................................................ 102 Errors ..................................................................................................................................................... 102 See Also ................................................................................................................................................ 103 DeleteUserSettings .................................................................................................................................. 105 Request Syntax .................................................................................................................................... 105 URI Request Parameters ................................................................................................................... 105 Request Body ....................................................................................................................................... 105 Response Syntax ................................................................................................................................. 105 Response Elements ............................................................................................................................ 105 Errors ..................................................................................................................................................... 105 See Also ................................................................................................................................................ 106 DisassociateBrowserSettings .................................................................................................................. 108 Request Syntax .................................................................................................................................... 108 URI Request Parameters ................................................................................................................... 108 Request Body ....................................................................................................................................... 108 Response Syntax ................................................................................................................................. 108 Response Elements ............................................................................................................................ 108 Errors ..................................................................................................................................................... 108 See Also ................................................................................................................................................ 109 DisassociateDataProtectionSettings ..................................................................................................... 111 Request Syntax .................................................................................................................................... 111 URI Request Parameters ................................................................................................................... 111 Request Body ....................................................................................................................................... 111 API Version 2020-07-08 viii Amazon WorkSpaces Secure Browser API Reference Response Syntax ................................................................................................................................. 111 Response Elements ............................................................................................................................ 111 Errors ..................................................................................................................................................... 111 See Also ................................................................................................................................................ 112 DisassociateIpAccessSettings ................................................................................................................. 114 Request Syntax .................................................................................................................................... 114 URI Request Parameters ................................................................................................................... 114 Request Body ....................................................................................................................................... 114 Response Syntax ................................................................................................................................. 114 Response Elements ............................................................................................................................ 114 Errors ..................................................................................................................................................... 114 See Also ................................................................................................................................................ 115 DisassociateNetworkSettings ................................................................................................................. 117 Request Syntax .................................................................................................................................... 117 URI Request Parameters ................................................................................................................... 117 Request Body ....................................................................................................................................... 117 Response Syntax ................................................................................................................................. 117 Response Elements ............................................................................................................................ 117 Errors ..................................................................................................................................................... 117 See Also ................................................................................................................................................ 118 DisassociateTrustStore ............................................................................................................................ 120 Request Syntax .................................................................................................................................... 120 URI Request Parameters ................................................................................................................... 120 Request Body ....................................................................................................................................... 120 Response Syntax ................................................................................................................................. 120 Response Elements ............................................................................................................................ 120 Errors ..................................................................................................................................................... 120 See Also ................................................................................................................................................ 121 DisassociateUserAccessLoggingSettings .............................................................................................. 123 Request Syntax .................................................................................................................................... 123 URI Request Parameters ................................................................................................................... 123 Request Body ....................................................................................................................................... 123 Response Syntax ................................................................................................................................. 123 Response Elements ............................................................................................................................ 123 Errors ..................................................................................................................................................... 123 See Also ................................................................................................................................................ 124 API Version 2020-07-08 ix Amazon WorkSpaces Secure Browser API Reference DisassociateUserSettings ........................................................................................................................ 126 Request Syntax .................................................................................................................................... 126 URI Request Parameters ................................................................................................................... 126 Request Body ....................................................................................................................................... 126 Response Syntax ................................................................................................................................. 126 Response Elements ............................................................................................................................ 126 Errors ..................................................................................................................................................... 126 See Also ................................................................................................................................................ 127 ExpireSession ............................................................................................................................................ 129 Request Syntax .................................................................................................................................... 129 URI Request Parameters ................................................................................................................... 129 Request Body ....................................................................................................................................... 129 Response Syntax ................................................................................................................................. 129 Response Elements ............................................................................................................................ 130 Errors ..................................................................................................................................................... 130 See Also ................................................................................................................................................ 130 GetBrowserSettings ................................................................................................................................. 132 Request Syntax .................................................................................................................................... 132 URI Request Parameters ................................................................................................................... 132 Request Body ....................................................................................................................................... 132 Response Syntax ................................................................................................................................. 132 Response Elements ............................................................................................................................ 133 Errors ..................................................................................................................................................... 133 See Also ................................................................................................................................................ 134 GetDataProtectionSettings .................................................................................................................... 135 Request Syntax .................................................................................................................................... 135 URI Request Parameters ................................................................................................................... 135 Request Body ....................................................................................................................................... 135 Response Syntax ................................................................................................................................. 135 Response Elements ............................................................................................................................ 136 Errors ..................................................................................................................................................... 136 See Also ................................................................................................................................................ 137 GetIdentityProvider ................................................................................................................................. 139 Request Syntax .................................................................................................................................... 139 URI Request Parameters ................................................................................................................... 139 Request Body ....................................................................................................................................... 139 API Version 2020-07-08 x Amazon WorkSpaces Secure Browser API Reference Response Syntax ................................................................................................................................. 139 Response Elements ............................................................................................................................ 140 Errors ..................................................................................................................................................... 140 See Also ................................................................................................................................................ 141 GetIpAccessSettings ................................................................................................................................. 142 Request Syntax .................................................................................................................................... 142 URI Request Parameters ................................................................................................................... 142 Request Body ....................................................................................................................................... 142 Response Syntax ................................................................................................................................. 142 Response Elements ............................................................................................................................ 143 Errors ..................................................................................................................................................... 143 See Also ................................................................................................................................................ 144 GetNetworkSettings ................................................................................................................................ 145 Request Syntax .................................................................................................................................... 145 URI Request Parameters ................................................................................................................... 145 Request Body ....................................................................................................................................... 145 Response Syntax ................................................................................................................................. 145 Response Elements ............................................................................................................................ 146 Errors ..................................................................................................................................................... 146 See Also ................................................................................................................................................ 147 GetPortal .................................................................................................................................................... 148 Request Syntax .................................................................................................................................... 148 URI Request Parameters ................................................................................................................... 148 Request Body ....................................................................................................................................... 148 Response Syntax ................................................................................................................................. 148 Response Elements ............................................................................................................................ 149 Errors ..................................................................................................................................................... 149 See Also ................................................................................................................................................ 150 GetPortalServiceProviderMetadata ...................................................................................................... 151 Request Syntax .................................................................................................................................... 151 URI Request Parameters ................................................................................................................... 151 Request Body ....................................................................................................................................... 151 Response Syntax ................................................................................................................................. 151 Response Elements ............................................................................................................................ 151 Errors ..................................................................................................................................................... 152 See Also ................................................................................................................................................ 153 API Version 2020-07-08 xi Amazon WorkSpaces Secure Browser API Reference GetSession ................................................................................................................................................. 154 Request Syntax .................................................................................................................................... 154 URI Request Parameters ................................................................................................................... 154 Request Body ....................................................................................................................................... 154 Response Syntax ................................................................................................................................. 154 Response Elements ............................................................................................................................ 155 Errors ..................................................................................................................................................... 155 See Also ................................................................................................................................................ 156 GetTrustStore ............................................................................................................................................ 157 Request Syntax .................................................................................................................................... 157 URI Request |
workspacesweb-api-003 | workspacesweb-api.pdf | 3 | Request Body ....................................................................................................................................... 148 Response Syntax ................................................................................................................................. 148 Response Elements ............................................................................................................................ 149 Errors ..................................................................................................................................................... 149 See Also ................................................................................................................................................ 150 GetPortalServiceProviderMetadata ...................................................................................................... 151 Request Syntax .................................................................................................................................... 151 URI Request Parameters ................................................................................................................... 151 Request Body ....................................................................................................................................... 151 Response Syntax ................................................................................................................................. 151 Response Elements ............................................................................................................................ 151 Errors ..................................................................................................................................................... 152 See Also ................................................................................................................................................ 153 API Version 2020-07-08 xi Amazon WorkSpaces Secure Browser API Reference GetSession ................................................................................................................................................. 154 Request Syntax .................................................................................................................................... 154 URI Request Parameters ................................................................................................................... 154 Request Body ....................................................................................................................................... 154 Response Syntax ................................................................................................................................. 154 Response Elements ............................................................................................................................ 155 Errors ..................................................................................................................................................... 155 See Also ................................................................................................................................................ 156 GetTrustStore ............................................................................................................................................ 157 Request Syntax .................................................................................................................................... 157 URI Request Parameters ................................................................................................................... 157 Request Body ....................................................................................................................................... 157 Response Syntax ................................................................................................................................. 157 Response Elements ............................................................................................................................ 158 Errors ..................................................................................................................................................... 158 See Also ................................................................................................................................................ 159 GetTrustStoreCertificate ......................................................................................................................... 160 Request Syntax .................................................................................................................................... 160 URI Request Parameters ................................................................................................................... 160 Request Body ....................................................................................................................................... 160 Response Syntax ................................................................................................................................. 160 Response Elements ............................................................................................................................ 161 Errors ..................................................................................................................................................... 161 See Also ................................................................................................................................................ 162 GetUserAccessLoggingSettings ............................................................................................................. 164 Request Syntax .................................................................................................................................... 164 URI Request Parameters ................................................................................................................... 164 Request Body ....................................................................................................................................... 164 Response Syntax ................................................................................................................................. 164 Response Elements ............................................................................................................................ 165 Errors ..................................................................................................................................................... 165 See Also ................................................................................................................................................ 166 GetUserSettings ........................................................................................................................................ 167 Request Syntax .................................................................................................................................... 167 URI Request Parameters ................................................................................................................... 167 Request Body ....................................................................................................................................... 167 API Version 2020-07-08 xii Amazon WorkSpaces Secure Browser API Reference Response Syntax ................................................................................................................................. 167 Response Elements ............................................................................................................................ 168 Errors ..................................................................................................................................................... 169 See Also ................................................................................................................................................ 169 ListBrowserSettings ................................................................................................................................. 171 Request Syntax .................................................................................................................................... 171 URI Request Parameters ................................................................................................................... 171 Request Body ....................................................................................................................................... 171 Response Syntax ................................................................................................................................. 171 Response Elements ............................................................................................................................ 172 Errors ..................................................................................................................................................... 172 See Also ................................................................................................................................................ 173 ListDataProtectionSettings .................................................................................................................... 174 Request Syntax .................................................................................................................................... 174 URI Request Parameters ................................................................................................................... 174 Request Body ....................................................................................................................................... 174 Response Syntax ................................................................................................................................. 174 Response Elements ............................................................................................................................ 175 Errors ..................................................................................................................................................... 175 See Also ................................................................................................................................................ 176 ListIdentityProviders ................................................................................................................................ 177 Request Syntax .................................................................................................................................... 177 URI Request Parameters ................................................................................................................... 177 Request Body ....................................................................................................................................... 177 Response Syntax ................................................................................................................................. 178 Response Elements ............................................................................................................................ 178 Errors ..................................................................................................................................................... 178 See Also ................................................................................................................................................ 179 ListIpAccessSettings ................................................................................................................................. 180 Request Syntax .................................................................................................................................... 180 URI Request Parameters ................................................................................................................... 180 Request Body ....................................................................................................................................... 180 Response Syntax ................................................................................................................................. 180 Response Elements ............................................................................................................................ 181 Errors ..................................................................................................................................................... 181 See Also ................................................................................................................................................ 182 API Version 2020-07-08 xiii Amazon WorkSpaces Secure Browser API Reference ListNetworkSettings ................................................................................................................................ 183 Request Syntax .................................................................................................................................... 183 URI Request Parameters ................................................................................................................... 183 Request Body ....................................................................................................................................... 183 Response Syntax ................................................................................................................................. 183 Response Elements ............................................................................................................................ 184 Errors ..................................................................................................................................................... 184 See Also ................................................................................................................................................ 185 ListPortals .................................................................................................................................................. 186 Request Syntax .................................................................................................................................... 186 URI Request Parameters ................................................................................................................... 186 Request Body ....................................................................................................................................... 186 Response Syntax ................................................................................................................................. 186 Response Elements ............................................................................................................................ 187 Errors ..................................................................................................................................................... 187 See Also ................................................................................................................................................ 188 ListSessions ............................................................................................................................................... 189 Request Syntax .................................................................................................................................... 189 URI Request Parameters ................................................................................................................... 189 Request Body ....................................................................................................................................... 190 Response Syntax ................................................................................................................................. 190 Response Elements ............................................................................................................................ 191 Errors ..................................................................................................................................................... 191 See Also ................................................................................................................................................ 192 ListTagsForResource ................................................................................................................................ 193 Request Syntax .................................................................................................................................... 193 URI Request Parameters ................................................................................................................... 193 Request Body ....................................................................................................................................... 193 Response Syntax ................................................................................................................................. 193 Response Elements ............................................................................................................................ 194 Errors ..................................................................................................................................................... 194 See Also ................................................................................................................................................ 195 ListTrustStoreCertificates ....................................................................................................................... 196 Request Syntax .................................................................................................................................... 196 URI Request Parameters ................................................................................................................... 196 Request Body ....................................................................................................................................... 196 API Version 2020-07-08 xiv Amazon WorkSpaces Secure Browser API Reference Response Syntax ................................................................................................................................. 197 Response Elements ............................................................................................................................ 197 Errors ..................................................................................................................................................... 198 See Also ................................................................................................................................................ 198 ListTrustStores .......................................................................................................................................... 200 Request Syntax .................................................................................................................................... 200 URI Request Parameters ................................................................................................................... 200 Request Body ....................................................................................................................................... 200 Response Syntax ................................................................................................................................. 200 Response Elements ............................................................................................................................ 201 Errors ..................................................................................................................................................... 201 See Also ................................................................................................................................................ 202 ListUserAccessLoggingSettings ............................................................................................................. 203 Request Syntax .................................................................................................................................... 203 URI Request Parameters ................................................................................................................... 203 Request Body ....................................................................................................................................... 203 Response Syntax ................................................................................................................................. 203 Response Elements ............................................................................................................................ 204 Errors ..................................................................................................................................................... 204 See Also ................................................................................................................................................ 205 ListUserSettings ........................................................................................................................................ 206 Request Syntax .................................................................................................................................... 206 URI Request Parameters ................................................................................................................... 206 Request Body ....................................................................................................................................... 206 Response Syntax ................................................................................................................................. 206 Response Elements ............................................................................................................................ 207 Errors ..................................................................................................................................................... 208 See Also ................................................................................................................................................ 208 TagResource .............................................................................................................................................. 210 Request Syntax .................................................................................................................................... 210 URI Request Parameters ................................................................................................................... 210 Request Body ....................................................................................................................................... 210 Response Syntax ................................................................................................................................. 211 Response Elements ............................................................................................................................ 211 Errors ..................................................................................................................................................... 211 See Also ................................................................................................................................................ 212 API Version 2020-07-08 xv Amazon WorkSpaces Secure Browser API Reference UntagResource .......................................................................................................................................... 214 Request Syntax .................................................................................................................................... 214 URI Request Parameters ................................................................................................................... 214 Request Body ....................................................................................................................................... 214 Response Syntax ................................................................................................................................. 214 Response Elements ............................................................................................................................ 215 Errors ..................................................................................................................................................... 215 See Also ................................................................................................................................................ 215 UpdateBrowserSettings .......................................................................................................................... 217 Request Syntax .................................................................................................................................... 217 URI Request Parameters ................................................................................................................... 217 Request Body ....................................................................................................................................... 217 Response Syntax ................................................................................................................................. 218 Response Elements ............................................................................................................................ 218 Errors ..................................................................................................................................................... 219 See Also ................................................................................................................................................ 219 UpdateDataProtectionSettings ............................................................................................................. 221 Request Syntax .................................................................................................................................... 221 URI Request Parameters ................................................................................................................... 221 Request Body ....................................................................................................................................... 222 Response Syntax ................................................................................................................................. 223 Response Elements ............................................................................................................................ 224 Errors ..................................................................................................................................................... 224 See Also ................................................................................................................................................ 225 UpdateIdentityProvider ........................................................................................................................... 226 Request Syntax .................................................................................................................................... 226 URI Request Parameters ................................................................................................................... 226 Request Body ....................................................................................................................................... 226 Response Syntax ................................................................................................................................. 229 Response Elements ............................................................................................................................ 229 Errors ..................................................................................................................................................... 229 See Also ................................................................................................................................................ 230 UpdateIpAccessSettings .......................................................................................................................... 232 Request Syntax .................................................................................................................................... 232 URI Request Parameters ................................................................................................................... 232 Request Body ....................................................................................................................................... 232 API Version |
workspacesweb-api-004 | workspacesweb-api.pdf | 4 | 217 Request Body ....................................................................................................................................... 217 Response Syntax ................................................................................................................................. 218 Response Elements ............................................................................................................................ 218 Errors ..................................................................................................................................................... 219 See Also ................................................................................................................................................ 219 UpdateDataProtectionSettings ............................................................................................................. 221 Request Syntax .................................................................................................................................... 221 URI Request Parameters ................................................................................................................... 221 Request Body ....................................................................................................................................... 222 Response Syntax ................................................................................................................................. 223 Response Elements ............................................................................................................................ 224 Errors ..................................................................................................................................................... 224 See Also ................................................................................................................................................ 225 UpdateIdentityProvider ........................................................................................................................... 226 Request Syntax .................................................................................................................................... 226 URI Request Parameters ................................................................................................................... 226 Request Body ....................................................................................................................................... 226 Response Syntax ................................................................................................................................. 229 Response Elements ............................................................................................................................ 229 Errors ..................................................................................................................................................... 229 See Also ................................................................................................................................................ 230 UpdateIpAccessSettings .......................................................................................................................... 232 Request Syntax .................................................................................................................................... 232 URI Request Parameters ................................................................................................................... 232 Request Body ....................................................................................................................................... 232 API Version 2020-07-08 xvi Amazon WorkSpaces Secure Browser API Reference Response Syntax ................................................................................................................................. 234 Response Elements ............................................................................................................................ 234 Errors ..................................................................................................................................................... 234 See Also ................................................................................................................................................ 235 UpdateNetworkSettings ......................................................................................................................... 237 Request Syntax .................................................................................................................................... 237 URI Request Parameters ................................................................................................................... 237 Request Body ....................................................................................................................................... 237 Response Syntax ................................................................................................................................. 239 Response Elements ............................................................................................................................ 239 Errors ..................................................................................................................................................... 239 See Also ................................................................................................................................................ 240 UpdatePortal ............................................................................................................................................. 241 Request Syntax .................................................................................................................................... 241 URI Request Parameters ................................................................................................................... 241 Request Body ....................................................................................................................................... 241 Response Syntax ................................................................................................................................. 243 Response Elements ............................................................................................................................ 243 Errors ..................................................................................................................................................... 244 See Also ................................................................................................................................................ 245 UpdateTrustStore ..................................................................................................................................... 246 Request Syntax .................................................................................................................................... 246 URI Request Parameters ................................................................................................................... 246 Request Body ....................................................................................................................................... 246 Response Syntax ................................................................................................................................. 247 Response Elements ............................................................................................................................ 247 Errors ..................................................................................................................................................... 248 See Also ................................................................................................................................................ 249 UpdateUserAccessLoggingSettings ...................................................................................................... 250 Request Syntax .................................................................................................................................... 250 URI Request Parameters ................................................................................................................... 250 Request Body ....................................................................................................................................... 250 Response Syntax ................................................................................................................................. 251 Response Elements ............................................................................................................................ 251 Errors ..................................................................................................................................................... 252 See Also ................................................................................................................................................ 252 API Version 2020-07-08 xvii Amazon WorkSpaces Secure Browser API Reference UpdateUserSettings ................................................................................................................................. 254 Request Syntax .................................................................................................................................... 254 URI Request Parameters ................................................................................................................... 255 Request Body ....................................................................................................................................... 255 Response Syntax ................................................................................................................................. 258 Response Elements ............................................................................................................................ 259 Errors ..................................................................................................................................................... 259 See Also ................................................................................................................................................ 260 Data Types ................................................................................................................................... 261 BrowserSettings ........................................................................................................................................ 263 Contents ............................................................................................................................................... 263 See Also ................................................................................................................................................ 264 BrowserSettingsSummary ...................................................................................................................... 265 Contents ............................................................................................................................................... 265 See Also ................................................................................................................................................ 265 Certificate .................................................................................................................................................. 266 Contents ............................................................................................................................................... 266 See Also ................................................................................................................................................ 267 CertificateSummary ................................................................................................................................. 268 Contents ............................................................................................................................................... 268 See Also ................................................................................................................................................ 269 CookieSpecification .................................................................................................................................. 270 Contents ............................................................................................................................................... 270 See Also ................................................................................................................................................ 270 CookieSynchronizationConfiguration ................................................................................................... 272 Contents ............................................................................................................................................... 272 See Also ................................................................................................................................................ 272 CustomPattern .......................................................................................................................................... 273 Contents ............................................................................................................................................... 273 See Also ................................................................................................................................................ 274 DataProtectionSettings ........................................................................................................................... 275 Contents ............................................................................................................................................... 275 See Also ................................................................................................................................................ 277 DataProtectionSettingsSummary ......................................................................................................... 278 Contents ............................................................................................................................................... 278 See Also ................................................................................................................................................ 279 API Version 2020-07-08 xviii Amazon WorkSpaces Secure Browser API Reference IdentityProvider ........................................................................................................................................ 280 Contents ............................................................................................................................................... 280 See Also ................................................................................................................................................ 282 IdentityProviderSummary ...................................................................................................................... 283 Contents ............................................................................................................................................... 283 See Also ................................................................................................................................................ 284 InlineRedactionConfiguration ................................................................................................................ 285 Contents ............................................................................................................................................... 285 See Also ................................................................................................................................................ 286 InlineRedactionPattern ........................................................................................................................... 287 Contents ............................................................................................................................................... 287 See Also ................................................................................................................................................ 288 IpAccessSettings ....................................................................................................................................... 290 Contents ............................................................................................................................................... 290 See Also ................................................................................................................................................ 292 IpAccessSettingsSummary ...................................................................................................................... 293 Contents ............................................................................................................................................... 293 See Also ................................................................................................................................................ 294 IpRule .......................................................................................................................................................... 295 Contents ............................................................................................................................................... 295 See Also ................................................................................................................................................ 295 NetworkSettings ....................................................................................................................................... 296 Contents ............................................................................................................................................... 296 See Also ................................................................................................................................................ 297 NetworkSettingsSummary ..................................................................................................................... 298 Contents ............................................................................................................................................... 298 See Also ................................................................................................................................................ 298 Portal .......................................................................................................................................................... 299 Contents ............................................................................................................................................... 299 See Also ................................................................................................................................................ 304 PortalSummary ......................................................................................................................................... 305 Contents ............................................................................................................................................... 305 See Also ................................................................................................................................................ 309 RedactionPlaceHolder ............................................................................................................................. 310 Contents ............................................................................................................................................... 310 See Also ................................................................................................................................................ 310 API Version 2020-07-08 xix Amazon WorkSpaces Secure Browser API Reference Session ........................................................................................................................................................ 311 Contents ............................................................................................................................................... 311 See Also ................................................................................................................................................ 313 SessionSummary ...................................................................................................................................... 314 Contents ............................................................................................................................................... 314 See Also ................................................................................................................................................ 315 Tag ............................................................................................................................................................... 316 Contents ............................................................................................................................................... 316 See Also ................................................................................................................................................ 316 ToolbarConfiguration .............................................................................................................................. 317 Contents ............................................................................................................................................... 317 See Also ................................................................................................................................................ 318 TrustStore .................................................................................................................................................. 319 Contents ............................................................................................................................................... 319 See Also ................................................................................................................................................ 319 TrustStoreSummary ................................................................................................................................. 321 Contents ............................................................................................................................................... 321 See Also ................................................................................................................................................ 321 UserAccessLoggingSettings .................................................................................................................... 322 Contents ............................................................................................................................................... 322 See Also ................................................................................................................................................ 323 UserAccessLoggingSettingsSummary .................................................................................................. 324 Contents ............................................................................................................................................... 324 See Also ................................................................................................................................................ 324 UserSettings .............................................................................................................................................. 325 Contents ............................................................................................................................................... 325 See Also ................................................................................................................................................ 328 UserSettingsSummary ............................................................................................................................. 329 Contents ............................................................................................................................................... 329 See Also ................................................................................................................................................ 331 ValidationExceptionField ........................................................................................................................ 332 Contents ............................................................................................................................................... 332 See Also ................................................................................................................................................ 332 Common Parameters ................................................................................................................... 333 Common Errors ............................................................................................................................ 336 API Version 2020-07-08 xx Amazon WorkSpaces Secure Browser API Reference Welcome Amazon WorkSpaces Secure Browser is a low cost, fully managed WorkSpace built specifically to facilitate secure, web-based workloads. WorkSpaces Secure Browser makes it easy for customers to safely provide their employees with access to internal websites and SaaS web applications without the administrative burden of appliances or specialized client software. WorkSpaces Secure Browser provides simple policy tools tailored for user interactions, while offloading common tasks like capacity management, scaling, and maintaining browser images. This document was last published on May 21, 2025. API Version 2020-07-08 1 Amazon WorkSpaces Secure Browser API Reference Actions The following actions are supported: • AssociateBrowserSettings • AssociateDataProtectionSettings • AssociateIpAccessSettings • AssociateNetworkSettings • AssociateTrustStore • AssociateUserAccessLoggingSettings • AssociateUserSettings • CreateBrowserSettings • CreateDataProtectionSettings • CreateIdentityProvider • CreateIpAccessSettings • CreateNetworkSettings • CreatePortal • CreateTrustStore • CreateUserAccessLoggingSettings • CreateUserSettings • DeleteBrowserSettings • DeleteDataProtectionSettings • DeleteIdentityProvider • DeleteIpAccessSettings • DeleteNetworkSettings • DeletePortal • DeleteTrustStore • DeleteUserAccessLoggingSettings • DeleteUserSettings • |
workspacesweb-api-005 | workspacesweb-api.pdf | 5 | software. WorkSpaces Secure Browser provides simple policy tools tailored for user interactions, while offloading common tasks like capacity management, scaling, and maintaining browser images. This document was last published on May 21, 2025. API Version 2020-07-08 1 Amazon WorkSpaces Secure Browser API Reference Actions The following actions are supported: • AssociateBrowserSettings • AssociateDataProtectionSettings • AssociateIpAccessSettings • AssociateNetworkSettings • AssociateTrustStore • AssociateUserAccessLoggingSettings • AssociateUserSettings • CreateBrowserSettings • CreateDataProtectionSettings • CreateIdentityProvider • CreateIpAccessSettings • CreateNetworkSettings • CreatePortal • CreateTrustStore • CreateUserAccessLoggingSettings • CreateUserSettings • DeleteBrowserSettings • DeleteDataProtectionSettings • DeleteIdentityProvider • DeleteIpAccessSettings • DeleteNetworkSettings • DeletePortal • DeleteTrustStore • DeleteUserAccessLoggingSettings • DeleteUserSettings • DisassociateBrowserSettings • DisassociateDataProtectionSettings API Version 2020-07-08 2 Amazon WorkSpaces Secure Browser • DisassociateIpAccessSettings • DisassociateNetworkSettings • DisassociateTrustStore • DisassociateUserAccessLoggingSettings • DisassociateUserSettings • ExpireSession • GetBrowserSettings • GetDataProtectionSettings • GetIdentityProvider • GetIpAccessSettings • GetNetworkSettings • GetPortal • GetPortalServiceProviderMetadata • GetSession • GetTrustStore • GetTrustStoreCertificate • GetUserAccessLoggingSettings • GetUserSettings • ListBrowserSettings • ListDataProtectionSettings • ListIdentityProviders • ListIpAccessSettings • ListNetworkSettings • ListPortals • ListSessions • ListTagsForResource • ListTrustStoreCertificates • ListTrustStores • ListUserAccessLoggingSettings • ListUserSettings API Reference API Version 2020-07-08 3 Amazon WorkSpaces Secure Browser API Reference • TagResource • UntagResource • UpdateBrowserSettings • UpdateDataProtectionSettings • UpdateIdentityProvider • UpdateIpAccessSettings • UpdateNetworkSettings • UpdatePortal • UpdateTrustStore • UpdateUserAccessLoggingSettings • UpdateUserSettings API Version 2020-07-08 4 Amazon WorkSpaces Secure Browser API Reference AssociateBrowserSettings Associates a browser settings resource with a web portal. Request Syntax PUT /portals/portalArn+/browserSettings?browserSettingsArn=browserSettingsArn HTTP/1.1 URI Request Parameters The request uses the following URI parameters. browserSettingsArn The ARN of the browser settings. Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ Required: Yes portalArn The ARN of the web portal. Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 AssociateBrowserSettings API Version 2020-07-08 5 Amazon WorkSpaces Secure Browser API Reference Content-type: application/json { "browserSettingsArn": "string", "portalArn": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. browserSettingsArn The ARN of the browser settings. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ portalArn The ARN of the web portal. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Access is denied. Response Elements API Version 2020-07-08 6 API Reference Amazon WorkSpaces Secure Browser HTTP Status Code: 403 ConflictException There is a conflict. HTTP Status Code: 409 InternalServerException There is an internal server error. HTTP Status Code: 500 ResourceNotFoundException The resource cannot be found. HTTP Status Code: 404 ThrottlingException There is a throttling error. HTTP Status Code: 429 ValidationException There is a validation error. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 See Also API Version 2020-07-08 7 Amazon WorkSpaces Secure Browser • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2020-07-08 8 Amazon WorkSpaces Secure Browser API Reference AssociateDataProtectionSettings Associates a data protection settings resource with a web portal. Request Syntax PUT /portals/portalArn+/dataProtectionSettings? dataProtectionSettingsArn=dataProtectionSettingsArn HTTP/1.1 URI Request Parameters The request uses the following URI parameters. dataProtectionSettingsArn The ARN of the data protection settings. Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ Required: Yes portalArn The ARN of the web portal. Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 AssociateDataProtectionSettings API Version 2020-07-08 9 Amazon WorkSpaces Secure Browser API Reference Content-type: application/json { "dataProtectionSettingsArn": "string", "portalArn": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. dataProtectionSettingsArn The ARN of the data protection settings resource. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ portalArn The ARN of the web portal. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Access is denied. Response Elements API Version 2020-07-08 10 API Reference Amazon WorkSpaces Secure Browser HTTP Status Code: 403 ConflictException There is a conflict. HTTP Status Code: 409 InternalServerException There is an internal server error. HTTP Status |
workspacesweb-api-006 | workspacesweb-api.pdf | 6 | service. dataProtectionSettingsArn The ARN of the data protection settings resource. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ portalArn The ARN of the web portal. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Access is denied. Response Elements API Version 2020-07-08 10 API Reference Amazon WorkSpaces Secure Browser HTTP Status Code: 403 ConflictException There is a conflict. HTTP Status Code: 409 InternalServerException There is an internal server error. HTTP Status Code: 500 ResourceNotFoundException The resource cannot be found. HTTP Status Code: 404 ThrottlingException There is a throttling error. HTTP Status Code: 429 ValidationException There is a validation error. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 See Also API Version 2020-07-08 11 Amazon WorkSpaces Secure Browser • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2020-07-08 12 Amazon WorkSpaces Secure Browser API Reference AssociateIpAccessSettings Associates an IP access settings resource with a web portal. Request Syntax PUT /portals/portalArn+/ipAccessSettings?ipAccessSettingsArn=ipAccessSettingsArn HTTP/1.1 URI Request Parameters The request uses the following URI parameters. ipAccessSettingsArn The ARN of the IP access settings. Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ Required: Yes portalArn The ARN of the web portal. Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 AssociateIpAccessSettings API Version 2020-07-08 13 Amazon WorkSpaces Secure Browser API Reference Content-type: application/json { "ipAccessSettingsArn": "string", "portalArn": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ipAccessSettingsArn The ARN of the IP access settings resource. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ portalArn The ARN of the web portal. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Access is denied. Response Elements API Version 2020-07-08 14 API Reference Amazon WorkSpaces Secure Browser HTTP Status Code: 403 ConflictException There is a conflict. HTTP Status Code: 409 InternalServerException There is an internal server error. HTTP Status Code: 500 ResourceNotFoundException The resource cannot be found. HTTP Status Code: 404 ThrottlingException There is a throttling error. HTTP Status Code: 429 ValidationException There is a validation error. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 See Also API Version 2020-07-08 15 Amazon WorkSpaces Secure Browser • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2020-07-08 16 Amazon WorkSpaces Secure Browser API Reference AssociateNetworkSettings Associates a network settings resource with a web portal. Request Syntax PUT /portals/portalArn+/networkSettings?networkSettingsArn=networkSettingsArn HTTP/1.1 URI Request Parameters The request uses the following URI parameters. networkSettingsArn The ARN of the network settings. Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ Required: Yes portalArn The ARN of the web portal. Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 AssociateNetworkSettings API Version 2020-07-08 17 Amazon WorkSpaces Secure Browser API Reference Content-type: application/json { "networkSettingsArn": "string", "portalArn": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. networkSettingsArn The ARN of the network settings. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ portalArn The ARN of the web portal. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Access is denied. Response Elements API Version 2020-07-08 18 API Reference Amazon WorkSpaces Secure Browser HTTP Status Code: 403 ConflictException There is a |
workspacesweb-api-007 | workspacesweb-api.pdf | 7 | sends back an HTTP 200 response. The following data is returned in JSON format by the service. networkSettingsArn The ARN of the network settings. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ portalArn The ARN of the web portal. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Access is denied. Response Elements API Version 2020-07-08 18 API Reference Amazon WorkSpaces Secure Browser HTTP Status Code: 403 ConflictException There is a conflict. HTTP Status Code: 409 InternalServerException There is an internal server error. HTTP Status Code: 500 ResourceNotFoundException The resource cannot be found. HTTP Status Code: 404 ThrottlingException There is a throttling error. HTTP Status Code: 429 ValidationException There is a validation error. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 See Also API Version 2020-07-08 19 Amazon WorkSpaces Secure Browser • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2020-07-08 20 Amazon WorkSpaces Secure Browser AssociateTrustStore Associates a trust store with a web portal. Request Syntax API Reference PUT /portals/portalArn+/trustStores?trustStoreArn=trustStoreArn HTTP/1.1 URI Request Parameters The request uses the following URI parameters. portalArn The ARN of the web portal. Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ Required: Yes trustStoreArn The ARN of the trust store. Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 AssociateTrustStore API Version 2020-07-08 21 Amazon WorkSpaces Secure Browser API Reference Content-type: application/json { "portalArn": "string", "trustStoreArn": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. portalArn The ARN of the web portal. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ trustStoreArn The ARN of the trust store. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Access is denied. Response Elements API Version 2020-07-08 22 API Reference Amazon WorkSpaces Secure Browser HTTP Status Code: 403 ConflictException There is a conflict. HTTP Status Code: 409 InternalServerException There is an internal server error. HTTP Status Code: 500 ResourceNotFoundException The resource cannot be found. HTTP Status Code: 404 ThrottlingException There is a throttling error. HTTP Status Code: 429 ValidationException There is a validation error. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 See Also API Version 2020-07-08 23 Amazon WorkSpaces Secure Browser • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2020-07-08 24 Amazon WorkSpaces Secure Browser API Reference AssociateUserAccessLoggingSettings Associates a user access logging settings resource with a web portal. Request Syntax PUT /portals/portalArn+/userAccessLoggingSettings? userAccessLoggingSettingsArn=userAccessLoggingSettingsArn HTTP/1.1 URI Request Parameters The request uses the following URI parameters. portalArn The ARN of the web portal. Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ Required: Yes userAccessLoggingSettingsArn The ARN of the user access logging settings. Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 AssociateUserAccessLoggingSettings API Version 2020-07-08 25 Amazon WorkSpaces Secure Browser API Reference Content-type: application/json { "portalArn": "string", "userAccessLoggingSettingsArn": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. portalArn The ARN of the web portal. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ userAccessLoggingSettingsArn The ARN of the user access logging settings. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Access is denied. Response Elements API Version |
workspacesweb-api-008 | workspacesweb-api.pdf | 8 | "portalArn": "string", "userAccessLoggingSettingsArn": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. portalArn The ARN of the web portal. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ userAccessLoggingSettingsArn The ARN of the user access logging settings. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Access is denied. Response Elements API Version 2020-07-08 26 API Reference Amazon WorkSpaces Secure Browser HTTP Status Code: 403 ConflictException There is a conflict. HTTP Status Code: 409 InternalServerException There is an internal server error. HTTP Status Code: 500 ResourceNotFoundException The resource cannot be found. HTTP Status Code: 404 ThrottlingException There is a throttling error. HTTP Status Code: 429 ValidationException There is a validation error. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 See Also API Version 2020-07-08 27 Amazon WorkSpaces Secure Browser • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2020-07-08 28 Amazon WorkSpaces Secure Browser API Reference AssociateUserSettings Associates a user settings resource with a web portal. Request Syntax PUT /portals/portalArn+/userSettings?userSettingsArn=userSettingsArn HTTP/1.1 URI Request Parameters The request uses the following URI parameters. portalArn The ARN of the web portal. Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ Required: Yes userSettingsArn The ARN of the user settings. Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 AssociateUserSettings API Version 2020-07-08 29 Amazon WorkSpaces Secure Browser API Reference Content-type: application/json { "portalArn": "string", "userSettingsArn": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. portalArn The ARN of the web portal. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ userSettingsArn The ARN of the user settings. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Access is denied. Response Elements API Version 2020-07-08 30 API Reference Amazon WorkSpaces Secure Browser HTTP Status Code: 403 ConflictException There is a conflict. HTTP Status Code: 409 InternalServerException There is an internal server error. HTTP Status Code: 500 ResourceNotFoundException The resource cannot be found. HTTP Status Code: 404 ThrottlingException There is a throttling error. HTTP Status Code: 429 ValidationException There is a validation error. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 See Also API Version 2020-07-08 31 Amazon WorkSpaces Secure Browser • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2020-07-08 32 Amazon WorkSpaces Secure Browser API Reference CreateBrowserSettings Creates a browser settings resource that can be associated with a web portal. Once associated with a web portal, browser settings control how the browser will behave once a user starts a streaming session for the web portal. Request Syntax POST /browserSettings HTTP/1.1 Content-type: application/json { "additionalEncryptionContext": { "string" : "string" }, "browserPolicy": "string", "clientToken": "string", "customerManagedKey": "string", "tags": [ { "Key": "string", "Value": "string" } ] } URI Request Parameters The request does not use any URI parameters. Request Body The request accepts the following data in JSON format. additionalEncryptionContext Additional encryption context of the browser settings. Type: String to string map Key Length Constraints: Minimum length of 0. Maximum length of 131072. CreateBrowserSettings API Version 2020-07-08 33 Amazon WorkSpaces Secure Browser Key Pattern: ^[\s\S]*$ API Reference Value Length Constraints: Minimum length of 0. Maximum length of 131072. Value Pattern: ^[\s\S]*$ Required: No browserPolicy A JSON string containing Chrome Enterprise policies that will be applied to all streaming sessions. Type: String Length Constraints: Minimum length of 2. Maximum length of 131072. Pattern: \{[\S\s]*\}\s* Required: Yes clientToken A unique, case-sensitive identifier that you provide |
workspacesweb-api-009 | workspacesweb-api.pdf | 9 | the following data in JSON format. additionalEncryptionContext Additional encryption context of the browser settings. Type: String to string map Key Length Constraints: Minimum length of 0. Maximum length of 131072. CreateBrowserSettings API Version 2020-07-08 33 Amazon WorkSpaces Secure Browser Key Pattern: ^[\s\S]*$ API Reference Value Length Constraints: Minimum length of 0. Maximum length of 131072. Value Pattern: ^[\s\S]*$ Required: No browserPolicy A JSON string containing Chrome Enterprise policies that will be applied to all streaming sessions. Type: String Length Constraints: Minimum length of 2. Maximum length of 131072. Pattern: \{[\S\s]*\}\s* Required: Yes clientToken A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request. If you do not specify a client token, one is automatically generated by the AWS SDK. Type: String Length Constraints: Minimum length of 1. Maximum length of 512. Required: No customerManagedKey The custom managed key of the browser settings. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:kms:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:key\/[a- zA-Z0-9-]+$ Request Body API Version 2020-07-08 34 Amazon WorkSpaces Secure Browser API Reference Required: No tags The tags to add to the browser settings resource. A tag is a key-value pair. Type: Array of Tag objects Array Members: Minimum number of 0 items. Maximum number of 200 items. Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "browserSettingsArn": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. browserSettingsArn The ARN of the browser settings. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ Errors For information about the errors that are common to all actions, see Common Errors. Response Syntax API Version 2020-07-08 35 API Reference Amazon WorkSpaces Secure Browser AccessDeniedException Access is denied. HTTP Status Code: 403 ConflictException There is a conflict. HTTP Status Code: 409 InternalServerException There is an internal server error. HTTP Status Code: 500 ResourceNotFoundException The resource cannot be found. HTTP Status Code: 404 ServiceQuotaExceededException The service quota has been exceeded. HTTP Status Code: 402 ThrottlingException There is a throttling error. HTTP Status Code: 429 ValidationException There is a validation error. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: See Also API Version 2020-07-08 36 API Reference Amazon WorkSpaces Secure Browser • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-07-08 37 Amazon WorkSpaces Secure Browser API Reference CreateDataProtectionSettings Creates a data protection settings resource that can be associated with a web portal. Request Syntax POST /dataProtectionSettings HTTP/1.1 Content-type: application/json { "additionalEncryptionContext": { "string" : "string" }, "clientToken": "string", "customerManagedKey": "string", "description": "string", "displayName": "string", "inlineRedactionConfiguration": { "globalConfidenceLevel": number, "globalEnforcedUrls": [ "string" ], "globalExemptUrls": [ "string" ], "inlineRedactionPatterns": [ { "builtInPatternId": "string", "confidenceLevel": number, "customPattern": { "keywordRegex": "string", "patternDescription": "string", "patternName": "string", "patternRegex": "string" }, "enforcedUrls": [ "string" ], "exemptUrls": [ "string" ], "redactionPlaceHolder": { "redactionPlaceHolderText": "string", "redactionPlaceHolderType": "string" } } ] }, "tags": [ { "Key": "string", CreateDataProtectionSettings API Version 2020-07-08 38 API Reference Amazon WorkSpaces Secure Browser "Value": "string" } ] } URI Request Parameters The request does not use any URI parameters. Request Body The request accepts the following data in JSON format. additionalEncryptionContext Additional encryption context of the data protection settings. Type: String to string map Key Length Constraints: Minimum length of 0. Maximum length of 131072. Key Pattern: ^[\s\S]*$ Value Length Constraints: Minimum length of 0. Maximum length of 131072. Value Pattern: ^[\s\S]*$ Required: No clientToken A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request. If you do not specify a client token, one is automatically generated by the AWS SDK. Type: String Length Constraints: Minimum length of 1. Maximum length of 512. Required: No URI Request Parameters API Version 2020-07-08 39 Amazon WorkSpaces Secure Browser customerManagedKey API Reference The custom managed key of the data protection settings. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:kms:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:key\/[a- zA-Z0-9-]+$ Required: No description The description of the data protection settings. Type: String Length Constraints: Minimum |
workspacesweb-api-010 | workspacesweb-api.pdf | 10 | completes successfully, subsequent retries with the same client token returns the result from the original successful request. If you do not specify a client token, one is automatically generated by the AWS SDK. Type: String Length Constraints: Minimum length of 1. Maximum length of 512. Required: No URI Request Parameters API Version 2020-07-08 39 Amazon WorkSpaces Secure Browser customerManagedKey API Reference The custom managed key of the data protection settings. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:kms:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:key\/[a- zA-Z0-9-]+$ Required: No description The description of the data protection settings. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: ^[ _\-\d\w]+$ Required: No displayName The display name of the data protection settings. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: ^[ _\-\d\w]+$ Required: No inlineRedactionConfiguration The inline redaction configuration of the data protection settings that will be applied to all sessions. Type: InlineRedactionConfiguration object Required: No Request Body API Version 2020-07-08 40 Amazon WorkSpaces Secure Browser API Reference tags The tags to add to the data protection settings resource. A tag is a key-value pair. Type: Array of Tag objects Array Members: Minimum number of 0 items. Maximum number of 200 items. Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "dataProtectionSettingsArn": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. dataProtectionSettingsArn The ARN of the data protection settings resource. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ Errors For information about the errors that are common to all actions, see Common Errors. Response Syntax API Version 2020-07-08 41 API Reference Amazon WorkSpaces Secure Browser AccessDeniedException Access is denied. HTTP Status Code: 403 ConflictException There is a conflict. HTTP Status Code: 409 InternalServerException There is an internal server error. HTTP Status Code: 500 ResourceNotFoundException The resource cannot be found. HTTP Status Code: 404 ServiceQuotaExceededException The service quota has been exceeded. HTTP Status Code: 402 ThrottlingException There is a throttling error. HTTP Status Code: 429 ValidationException There is a validation error. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: See Also API Version 2020-07-08 42 API Reference Amazon WorkSpaces Secure Browser • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-07-08 43 Amazon WorkSpaces Secure Browser API Reference CreateIdentityProvider Creates an identity provider resource that is then associated with a web portal. Request Syntax POST /identityProviders HTTP/1.1 Content-type: application/json { "clientToken": "string", "identityProviderDetails": { "string" : "string" }, "identityProviderName": "string", "identityProviderType": "string", "portalArn": "string", "tags": [ { "Key": "string", "Value": "string" } ] } URI Request Parameters The request does not use any URI parameters. Request Body The request accepts the following data in JSON format. clientToken A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request. If you do not specify a client token, one is automatically generated by the AWS SDK. CreateIdentityProvider API Version 2020-07-08 44 Amazon WorkSpaces Secure Browser Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 512. Required: No identityProviderDetails The identity provider details. The following list describes the provider detail keys for each identity provider type. • For Google and Login with Amazon: • client_id • client_secret • authorize_scopes • For Facebook: • client_id • client_secret • authorize_scopes • api_version • For Sign in with Apple: • client_id • team_id • key_id • private_key • authorize_scopes • For OIDC providers: • client_id • client_secret • attributes_request_method • oidc_issuer • authorize_scopes • authorize_url if not available from discovery URL specified by oidc_issuer key • token_url if not available from discovery URL specified by oidc_issuer key • attributes_url if not available from discovery URL specified by oidc_issuer key Request Body API Version 2020-07-08 45 Amazon WorkSpaces Secure Browser API Reference • jwks_uri if not available from discovery URL specified by oidc_issuer key • For SAML providers: • MetadataFile OR MetadataURL • IDPSignout (boolean) optional • IDPInit (boolean) optional • RequestSigningAlgorithm (string) optional - Only accepts rsa-sha256 • EncryptedResponses (boolean) optional Type: String to string map Key Length Constraints: Minimum length of 0. Maximum length of 131072. Key Pattern: ^[\s\S]*$ Value |
workspacesweb-api-011 | workspacesweb-api.pdf | 11 | specified by oidc_issuer key • token_url if not available from discovery URL specified by oidc_issuer key • attributes_url if not available from discovery URL specified by oidc_issuer key Request Body API Version 2020-07-08 45 Amazon WorkSpaces Secure Browser API Reference • jwks_uri if not available from discovery URL specified by oidc_issuer key • For SAML providers: • MetadataFile OR MetadataURL • IDPSignout (boolean) optional • IDPInit (boolean) optional • RequestSigningAlgorithm (string) optional - Only accepts rsa-sha256 • EncryptedResponses (boolean) optional Type: String to string map Key Length Constraints: Minimum length of 0. Maximum length of 131072. Key Pattern: ^[\s\S]*$ Value Length Constraints: Minimum length of 0. Maximum length of 131072. Value Pattern: ^[\s\S]*$ Required: Yes identityProviderName The identity provider name. Type: String Length Constraints: Minimum length of 1. Maximum length of 32. Pattern: ^[^_][\p{L}\p{M}\p{S}\p{N}\p{P}][^_]+$ Required: Yes identityProviderType The identity provider type. Type: String Valid Values: SAML | Facebook | Google | LoginWithAmazon | SignInWithApple | OIDC Required: Yes Request Body API Version 2020-07-08 46 Amazon WorkSpaces Secure Browser portalArn The ARN of the web portal. Type: String API Reference Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ Required: Yes tags The tags to add to the identity provider resource. A tag is a key-value pair. Type: Array of Tag objects Array Members: Minimum number of 0 items. Maximum number of 200 items. Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "identityProviderArn": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. identityProviderArn The ARN of the identity provider. Response Syntax API Version 2020-07-08 47 Amazon WorkSpaces Secure Browser Type: String API Reference Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36}){2,}$ Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Access is denied. HTTP Status Code: 403 ConflictException There is a conflict. HTTP Status Code: 409 InternalServerException There is an internal server error. HTTP Status Code: 500 ResourceNotFoundException The resource cannot be found. HTTP Status Code: 404 ServiceQuotaExceededException The service quota has been exceeded. HTTP Status Code: 402 ThrottlingException There is a throttling error. HTTP Status Code: 429 Errors API Version 2020-07-08 48 Amazon WorkSpaces Secure Browser ValidationException There is a validation error. HTTP Status Code: 400 See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-07-08 49 Amazon WorkSpaces Secure Browser API Reference CreateIpAccessSettings Creates an IP access settings resource that can be associated with a web portal. Request Syntax POST /ipAccessSettings HTTP/1.1 Content-type: application/json { "additionalEncryptionContext": { "string" : "string" }, "clientToken": "string", "customerManagedKey": "string", "description": "string", "displayName": "string", "ipRules": [ { "description": "string", "ipRange": "string" } ], "tags": [ { "Key": "string", "Value": "string" } ] } URI Request Parameters The request does not use any URI parameters. Request Body The request accepts the following data in JSON format. additionalEncryptionContext Additional encryption context of the IP access settings. CreateIpAccessSettings API Version 2020-07-08 50 Amazon WorkSpaces Secure Browser Type: String to string map API Reference Key Length Constraints: Minimum length of 0. Maximum length of 131072. Key Pattern: ^[\s\S]*$ Value Length Constraints: Minimum length of 0. Maximum length of 131072. Value Pattern: ^[\s\S]*$ Required: No clientToken A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request. If you do not specify a client token, one is automatically generated by the AWS SDK. Type: String Length Constraints: Minimum length of 1. Maximum length of 512. Required: No customerManagedKey The custom managed key of the IP access settings. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:kms:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:key\/[a- zA-Z0-9-]+$ Required: No description The description of the IP access settings. Type: String Request Body API Version 2020-07-08 51 Amazon WorkSpaces Secure Browser API Reference Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: ^.+$ Required: No displayName The display name of the IP access settings. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: ^.+$ Required: No ipRules The IP rules of the IP access settings. Type: Array of IpRule objects Array Members: Minimum number of 1 |
workspacesweb-api-012 | workspacesweb-api.pdf | 12 | access settings. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:kms:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:key\/[a- zA-Z0-9-]+$ Required: No description The description of the IP access settings. Type: String Request Body API Version 2020-07-08 51 Amazon WorkSpaces Secure Browser API Reference Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: ^.+$ Required: No displayName The display name of the IP access settings. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: ^.+$ Required: No ipRules The IP rules of the IP access settings. Type: Array of IpRule objects Array Members: Minimum number of 1 item. Maximum number of 100 items. Required: Yes tags The tags to add to the IP access settings resource. A tag is a key-value pair. Type: Array of Tag objects Array Members: Minimum number of 0 items. Maximum number of 200 items. Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "ipAccessSettingsArn": "string" Response Syntax API Version 2020-07-08 52 Amazon WorkSpaces Secure Browser API Reference } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ipAccessSettingsArn The ARN of the IP access settings resource. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Access is denied. HTTP Status Code: 403 ConflictException There is a conflict. HTTP Status Code: 409 InternalServerException There is an internal server error. HTTP Status Code: 500 ServiceQuotaExceededException The service quota has been exceeded. Response Elements API Version 2020-07-08 53 API Reference Amazon WorkSpaces Secure Browser HTTP Status Code: 402 ThrottlingException There is a throttling error. HTTP Status Code: 429 ValidationException There is a validation error. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-07-08 54 Amazon WorkSpaces Secure Browser API Reference CreateNetworkSettings Creates a network settings resource that can be associated with a web portal. Once associated with a web portal, network settings define how streaming instances will connect with your specified VPC. Request Syntax POST /networkSettings HTTP/1.1 Content-type: application/json { "clientToken": "string", "securityGroupIds": [ "string" ], "subnetIds": [ "string" ], "tags": [ { "Key": "string", "Value": "string" } ], "vpcId": "string" } URI Request Parameters The request does not use any URI parameters. Request Body The request accepts the following data in JSON format. clientToken A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request. If you do not specify a client token, one is automatically generated by the AWS SDK. CreateNetworkSettings API Version 2020-07-08 55 Amazon WorkSpaces Secure Browser Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 512. Required: No securityGroupIds One or more security groups used to control access from streaming instances to your VPC. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 5 items. Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: ^[\w+\-]+$ Required: Yes subnetIds The subnets in which network interfaces are created to connect streaming instances to your VPC. At least two of these subnets must be in different availability zones. Type: Array of strings Array Members: Minimum number of 2 items. Maximum number of 5 items. Length Constraints: Minimum length of 1. Maximum length of 32. Pattern: ^subnet-([0-9a-f]{8}|[0-9a-f]{17})$ Required: Yes tags The tags to add to the network settings resource. A tag is a key-value pair. Type: Array of Tag objects Array Members: Minimum number of 0 items. Maximum number of 200 items. Required: No Request Body API Version 2020-07-08 56 Amazon WorkSpaces Secure Browser API Reference vpcId The VPC that streaming instances will connect to. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: ^vpc-[0-9a-z]*$ Required: Yes Response Syntax HTTP/1.1 200 Content-type: application/json { "networkSettingsArn": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. networkSettingsArn The ARN of the network settings. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ Errors For information about |
workspacesweb-api-013 | workspacesweb-api.pdf | 13 | No Request Body API Version 2020-07-08 56 Amazon WorkSpaces Secure Browser API Reference vpcId The VPC that streaming instances will connect to. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: ^vpc-[0-9a-z]*$ Required: Yes Response Syntax HTTP/1.1 200 Content-type: application/json { "networkSettingsArn": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. networkSettingsArn The ARN of the network settings. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ Errors For information about the errors that are common to all actions, see Common Errors. Response Syntax API Version 2020-07-08 57 API Reference Amazon WorkSpaces Secure Browser AccessDeniedException Access is denied. HTTP Status Code: 403 ConflictException There is a conflict. HTTP Status Code: 409 InternalServerException There is an internal server error. HTTP Status Code: 500 ServiceQuotaExceededException The service quota has been exceeded. HTTP Status Code: 402 ThrottlingException There is a throttling error. HTTP Status Code: 429 ValidationException There is a validation error. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ See Also API Version 2020-07-08 58 Amazon WorkSpaces Secure Browser • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2020-07-08 59 Amazon WorkSpaces Secure Browser API Reference CreatePortal Creates a web portal. Request Syntax POST /portals HTTP/1.1 Content-type: application/json { "additionalEncryptionContext": { "string" : "string" }, "authenticationType": "string", "clientToken": "string", "customerManagedKey": "string", "displayName": "string", "instanceType": "string", "maxConcurrentSessions": number, "tags": [ { "Key": "string", "Value": "string" } ] } URI Request Parameters The request does not use any URI parameters. Request Body The request accepts the following data in JSON format. additionalEncryptionContext The additional encryption context of the portal. Type: String to string map Key Length Constraints: Minimum length of 0. Maximum length of 131072. CreatePortal API Version 2020-07-08 60 Amazon WorkSpaces Secure Browser Key Pattern: ^[\s\S]*$ API Reference Value Length Constraints: Minimum length of 0. Maximum length of 131072. Value Pattern: ^[\s\S]*$ Required: No authenticationType The type of authentication integration points used when signing into the web portal. Defaults to Standard. Standard web portals are authenticated directly through your identity provider. You need to call CreateIdentityProvider to integrate your identity provider with your web portal. User and group access to your web portal is controlled through your identity provider. IAM Identity Center web portals are authenticated through AWS IAM Identity Center. Identity sources (including external identity provider integration), plus user and group access to your web portal, can be configured in the IAM Identity Center. Type: String Valid Values: Standard | IAM_Identity_Center Required: No clientToken A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request. If you do not specify a client token, one is automatically generated by the AWS SDK. Type: String Length Constraints: Minimum length of 1. Maximum length of 512. Required: No customerManagedKey The customer managed key of the web portal. Request Body API Version 2020-07-08 61 Amazon WorkSpaces Secure Browser Type: String API Reference Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:kms:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:key\/[a- zA-Z0-9-]+$ Required: No displayName The name of the web portal. This is not visible to users who log into the web portal. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: ^.+$ Required: No instanceType The type and resources of the underlying instance. Type: String Valid Values: standard.regular | standard.large | standard.xlarge Required: No maxConcurrentSessions The maximum number of concurrent sessions for the portal. Type: Integer Valid Range: Minimum value of 1. Maximum value of 5000. Required: No tags The tags to add to the web portal. A tag is a key-value pair. Type: Array of Tag objects Array Members: Minimum number of 0 items. Maximum number of 200 items. Request Body API Version 2020-07-08 62 API Reference Amazon WorkSpaces Secure Browser Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "portalArn": "string", "portalEndpoint": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. portalArn The ARN of the web portal. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ portalEndpoint |
workspacesweb-api-014 | workspacesweb-api.pdf | 14 | web portal. A tag is a key-value pair. Type: Array of Tag objects Array Members: Minimum number of 0 items. Maximum number of 200 items. Request Body API Version 2020-07-08 62 API Reference Amazon WorkSpaces Secure Browser Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "portalArn": "string", "portalEndpoint": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. portalArn The ARN of the web portal. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ portalEndpoint The endpoint URL of the web portal that users access in order to start streaming sessions. Type: String Length Constraints: Minimum length of 1. Maximum length of 253. Pattern: ^[a-zA-Z0-9]?((?!-)([A-Za-z0-9-]*[A-Za-z0-9])\.)+[a-zA-Z0-9]+$ Errors For information about the errors that are common to all actions, see Common Errors. Response Syntax API Version 2020-07-08 63 API Reference Amazon WorkSpaces Secure Browser AccessDeniedException Access is denied. HTTP Status Code: 403 ConflictException There is a conflict. HTTP Status Code: 409 InternalServerException There is an internal server error. HTTP Status Code: 500 ResourceNotFoundException The resource cannot be found. HTTP Status Code: 404 ServiceQuotaExceededException The service quota has been exceeded. HTTP Status Code: 402 ThrottlingException There is a throttling error. HTTP Status Code: 429 ValidationException There is a validation error. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: See Also API Version 2020-07-08 64 API Reference Amazon WorkSpaces Secure Browser • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-07-08 65 Amazon WorkSpaces Secure Browser CreateTrustStore API Reference Creates a trust store that can be associated with a web portal. A trust store contains certificate authority (CA) certificates. Once associated with a web portal, the browser in a streaming session will recognize certificates that have been issued using any of the CAs in the trust store. If your organization has internal websites that use certificates issued by private CAs, you should add the private CA certificate to the trust store. Request Syntax POST /trustStores HTTP/1.1 Content-type: application/json { "certificateList": [ blob ], "clientToken": "string", "tags": [ { "Key": "string", "Value": "string" } ] } URI Request Parameters The request does not use any URI parameters. Request Body The request accepts the following data in JSON format. certificateList A list of CA certificates to be added to the trust store. Type: Array of Base64-encoded binary data objects Required: Yes CreateTrustStore API Version 2020-07-08 66 Amazon WorkSpaces Secure Browser clientToken API Reference A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request. If you do not specify a client token, one is automatically generated by the AWS SDK. Type: String Length Constraints: Minimum length of 1. Maximum length of 512. Required: No tags The tags to add to the trust store. A tag is a key-value pair. Type: Array of Tag objects Array Members: Minimum number of 0 items. Maximum number of 200 items. Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "trustStoreArn": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. trustStoreArn The ARN of the trust store. Response Syntax API Version 2020-07-08 67 Amazon WorkSpaces Secure Browser Type: String API Reference Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Access is denied. HTTP Status Code: 403 ConflictException There is a conflict. HTTP Status Code: 409 InternalServerException There is an internal server error. HTTP Status Code: 500 ServiceQuotaExceededException The service quota has been exceeded. HTTP Status Code: 402 ThrottlingException There is a throttling error. HTTP Status Code: 429 ValidationException There is a validation error. HTTP Status Code: 400 Errors API Version 2020-07-08 68 Amazon WorkSpaces Secure Browser API Reference See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for |
workspacesweb-api-015 | workspacesweb-api.pdf | 15 | Code: 500 ServiceQuotaExceededException The service quota has been exceeded. HTTP Status Code: 402 ThrottlingException There is a throttling error. HTTP Status Code: 429 ValidationException There is a validation error. HTTP Status Code: 400 Errors API Version 2020-07-08 68 Amazon WorkSpaces Secure Browser API Reference See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-07-08 69 Amazon WorkSpaces Secure Browser API Reference CreateUserAccessLoggingSettings Creates a user access logging settings resource that can be associated with a web portal. Request Syntax POST /userAccessLoggingSettings HTTP/1.1 Content-type: application/json { "clientToken": "string", "kinesisStreamArn": "string", "tags": [ { "Key": "string", "Value": "string" } ] } URI Request Parameters The request does not use any URI parameters. Request Body The request accepts the following data in JSON format. clientToken A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request. If you do not specify a client token, one is automatically generated by the AWS SDK. Type: String Length Constraints: Minimum length of 1. Maximum length of 512. Required: No CreateUserAccessLoggingSettings API Version 2020-07-08 70 Amazon WorkSpaces Secure Browser kinesisStreamArn The ARN of the Kinesis stream. Type: String API Reference Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:[\w+=/,.@-]+:kinesis:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:stream/. + Required: Yes tags The tags to add to the user settings resource. A tag is a key-value pair. Type: Array of Tag objects Array Members: Minimum number of 0 items. Maximum number of 200 items. Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "userAccessLoggingSettingsArn": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. userAccessLoggingSettingsArn The ARN of the user access logging settings. Response Syntax API Version 2020-07-08 71 Amazon WorkSpaces Secure Browser Type: String API Reference Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Access is denied. HTTP Status Code: 403 ConflictException There is a conflict. HTTP Status Code: 409 InternalServerException There is an internal server error. HTTP Status Code: 500 ServiceQuotaExceededException The service quota has been exceeded. HTTP Status Code: 402 ThrottlingException There is a throttling error. HTTP Status Code: 429 ValidationException There is a validation error. HTTP Status Code: 400 Errors API Version 2020-07-08 72 Amazon WorkSpaces Secure Browser API Reference See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-07-08 73 Amazon WorkSpaces Secure Browser CreateUserSettings API Reference Creates a user settings resource that can be associated with a web portal. Once associated with a web portal, user settings control how users can transfer data between a streaming session and the their local devices. Request Syntax POST /userSettings HTTP/1.1 Content-type: application/json { "additionalEncryptionContext": { "string" : "string" }, "clientToken": "string", "cookieSynchronizationConfiguration": { "allowlist": [ { "domain": "string", "name": "string", "path": "string" } ], "blocklist": [ { "domain": "string", "name": "string", "path": "string" } ] }, "copyAllowed": "string", "customerManagedKey": "string", "deepLinkAllowed": "string", "disconnectTimeoutInMinutes": number, "downloadAllowed": "string", "idleDisconnectTimeoutInMinutes": number, "pasteAllowed": "string", "printAllowed": "string", "tags": [ { CreateUserSettings API Version 2020-07-08 74 Amazon WorkSpaces Secure Browser API Reference "Key": "string", "Value": "string" } ], "toolbarConfiguration": { "hiddenToolbarItems": [ "string" ], "maxDisplayResolution": "string", "toolbarType": "string", "visualMode": "string" }, "uploadAllowed": "string" } URI Request Parameters The request does not use any URI parameters. Request Body The request accepts the following data in JSON format. additionalEncryptionContext The additional encryption context of the user settings. Type: String to string map Key Length Constraints: Minimum length of 0. Maximum length of 131072. Key Pattern: ^[\s\S]*$ Value Length Constraints: Minimum length of 0. Maximum length of 131072. Value Pattern: ^[\s\S]*$ Required: No clientToken A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes |
workspacesweb-api-016 | workspacesweb-api.pdf | 16 | "string" ], "maxDisplayResolution": "string", "toolbarType": "string", "visualMode": "string" }, "uploadAllowed": "string" } URI Request Parameters The request does not use any URI parameters. Request Body The request accepts the following data in JSON format. additionalEncryptionContext The additional encryption context of the user settings. Type: String to string map Key Length Constraints: Minimum length of 0. Maximum length of 131072. Key Pattern: ^[\s\S]*$ Value Length Constraints: Minimum length of 0. Maximum length of 131072. Value Pattern: ^[\s\S]*$ Required: No clientToken A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request. URI Request Parameters API Version 2020-07-08 75 Amazon WorkSpaces Secure Browser API Reference If you do not specify a client token, one is automatically generated by the AWS SDK. Type: String Length Constraints: Minimum length of 1. Maximum length of 512. Required: No cookieSynchronizationConfiguration The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser. Type: CookieSynchronizationConfiguration object Required: No copyAllowed Specifies whether the user can copy text from the streaming session to the local device. Type: String Valid Values: Disabled | Enabled Required: Yes customerManagedKey The customer managed key used to encrypt sensitive information in the user settings. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:kms:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:key\/[a- zA-Z0-9-]+$ Required: No deepLinkAllowed Specifies whether the user can use deep links that open automatically when connecting to a session. Type: String Request Body API Version 2020-07-08 76 Amazon WorkSpaces Secure Browser API Reference Valid Values: Disabled | Enabled Required: No disconnectTimeoutInMinutes The amount of time that a streaming session remains active after users disconnect. Type: Integer Valid Range: Minimum value of 1. Maximum value of 600. Required: No downloadAllowed Specifies whether the user can download files from the streaming session to the local device. Type: String Valid Values: Disabled | Enabled Required: Yes idleDisconnectTimeoutInMinutes The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect timeout interval begins. Type: Integer Valid Range: Minimum value of 0. Maximum value of 60. Required: No pasteAllowed Specifies whether the user can paste text from the local device to the streaming session. Type: String Valid Values: Disabled | Enabled Required: Yes printAllowed Specifies whether the user can print to the local device. Request Body API Version 2020-07-08 77 Amazon WorkSpaces Secure Browser Type: String Valid Values: Disabled | Enabled Required: Yes tags API Reference The tags to add to the user settings resource. A tag is a key-value pair. Type: Array of Tag objects Array Members: Minimum number of 0 items. Maximum number of 200 items. Required: No toolbarConfiguration The configuration of the toolbar. This allows administrators to select the toolbar type and visual mode, set maximum display resolution for sessions, and choose which items are visible to end users during their sessions. If administrators do not modify these settings, end users retain control over their toolbar preferences. Type: ToolbarConfiguration object Required: No uploadAllowed Specifies whether the user can upload files from the local device to the streaming session. Type: String Valid Values: Disabled | Enabled Required: Yes Response Syntax HTTP/1.1 200 Content-type: application/json { "userSettingsArn": "string" Response Syntax API Version 2020-07-08 78 Amazon WorkSpaces Secure Browser API Reference } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. userSettingsArn The ARN of the user settings. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Access is denied. HTTP Status Code: 403 ConflictException There is a conflict. HTTP Status Code: 409 InternalServerException There is an internal server error. HTTP Status Code: 500 ServiceQuotaExceededException The service quota has been exceeded. Response Elements API Version 2020-07-08 79 API Reference Amazon WorkSpaces Secure Browser HTTP Status Code: 402 ThrottlingException There is a throttling error. HTTP Status Code: 429 ValidationException There is a validation error. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-07-08 80 Amazon WorkSpaces Secure Browser API Reference DeleteBrowserSettings Deletes browser settings. Request |
workspacesweb-api-017 | workspacesweb-api.pdf | 17 | There is a validation error. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-07-08 80 Amazon WorkSpaces Secure Browser API Reference DeleteBrowserSettings Deletes browser settings. Request Syntax DELETE /browserSettings/browserSettingsArn+ HTTP/1.1 URI Request Parameters The request uses the following URI parameters. browserSettingsArn The ARN of the browser settings. Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. DeleteBrowserSettings API Version 2020-07-08 81 API Reference Amazon WorkSpaces Secure Browser AccessDeniedException Access is denied. HTTP Status Code: 403 ConflictException There is a conflict. HTTP Status Code: 409 InternalServerException There is an internal server error. HTTP Status Code: 500 ThrottlingException There is a throttling error. HTTP Status Code: 429 ValidationException There is a validation error. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin See Also API Version 2020-07-08 82 Amazon WorkSpaces Secure Browser • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2020-07-08 83 Amazon WorkSpaces Secure Browser API Reference DeleteDataProtectionSettings Deletes data protection settings. Request Syntax DELETE /dataProtectionSettings/dataProtectionSettingsArn+ HTTP/1.1 URI Request Parameters The request uses the following URI parameters. dataProtectionSettingsArn The ARN of the data protection settings. Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. DeleteDataProtectionSettings API Version 2020-07-08 84 API Reference Amazon WorkSpaces Secure Browser AccessDeniedException Access is denied. HTTP Status Code: 403 ConflictException There is a conflict. HTTP Status Code: 409 InternalServerException There is an internal server error. HTTP Status Code: 500 ThrottlingException There is a throttling error. HTTP Status Code: 429 ValidationException There is a validation error. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin See Also API Version 2020-07-08 85 Amazon WorkSpaces Secure Browser • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2020-07-08 86 Amazon WorkSpaces Secure Browser API Reference DeleteIdentityProvider Deletes the identity provider. Request Syntax DELETE /identityProviders/identityProviderArn+ HTTP/1.1 URI Request Parameters The request uses the following URI parameters. identityProviderArn The ARN of the identity provider. Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36}){2,}$ Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. DeleteIdentityProvider API Version 2020-07-08 87 API Reference Amazon WorkSpaces Secure Browser AccessDeniedException Access is denied. HTTP Status Code: 403 ConflictException There is a conflict. HTTP Status Code: 409 InternalServerException There is an internal server error. HTTP Status Code: 500 ThrottlingException There is a throttling error. HTTP Status Code: 429 ValidationException There is a validation error. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin See Also |
workspacesweb-api-018 | workspacesweb-api.pdf | 18 | 403 ConflictException There is a conflict. HTTP Status Code: 409 InternalServerException There is an internal server error. HTTP Status Code: 500 ThrottlingException There is a throttling error. HTTP Status Code: 429 ValidationException There is a validation error. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin See Also API Version 2020-07-08 88 Amazon WorkSpaces Secure Browser • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2020-07-08 89 Amazon WorkSpaces Secure Browser API Reference DeleteIpAccessSettings Deletes IP access settings. Request Syntax DELETE /ipAccessSettings/ipAccessSettingsArn+ HTTP/1.1 URI Request Parameters The request uses the following URI parameters. ipAccessSettingsArn The ARN of the IP access settings. Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. DeleteIpAccessSettings API Version 2020-07-08 90 API Reference Amazon WorkSpaces Secure Browser AccessDeniedException Access is denied. HTTP Status Code: 403 ConflictException There is a conflict. HTTP Status Code: 409 InternalServerException There is an internal server error. HTTP Status Code: 500 ThrottlingException There is a throttling error. HTTP Status Code: 429 ValidationException There is a validation error. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin See Also API Version 2020-07-08 91 Amazon WorkSpaces Secure Browser • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2020-07-08 92 Amazon WorkSpaces Secure Browser API Reference DeleteNetworkSettings Deletes network settings. Request Syntax DELETE /networkSettings/networkSettingsArn+ HTTP/1.1 URI Request Parameters The request uses the following URI parameters. networkSettingsArn The ARN of the network settings. Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. DeleteNetworkSettings API Version 2020-07-08 93 API Reference Amazon WorkSpaces Secure Browser AccessDeniedException Access is denied. HTTP Status Code: 403 ConflictException There is a conflict. HTTP Status Code: 409 InternalServerException There is an internal server error. HTTP Status Code: 500 ThrottlingException There is a throttling error. HTTP Status Code: 429 ValidationException There is a validation error. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin See Also API Version 2020-07-08 94 Amazon WorkSpaces Secure Browser • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2020-07-08 95 Amazon WorkSpaces Secure Browser API Reference DeletePortal Deletes a web portal. Request Syntax DELETE /portals/portalArn+ HTTP/1.1 URI Request Parameters The request uses the following URI parameters. portalArn The ARN of the web portal. Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. DeletePortal API Version 2020-07-08 96 API Reference Amazon WorkSpaces Secure Browser AccessDeniedException Access is denied. HTTP Status Code: 403 ConflictException There is a conflict. HTTP Status Code: 409 InternalServerException There is an internal server error. HTTP Status Code: 500 ThrottlingException There is a throttling error. HTTP Status Code: 429 ValidationException There is a validation error. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS |
workspacesweb-api-019 | workspacesweb-api.pdf | 19 | sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. DeletePortal API Version 2020-07-08 96 API Reference Amazon WorkSpaces Secure Browser AccessDeniedException Access is denied. HTTP Status Code: 403 ConflictException There is a conflict. HTTP Status Code: 409 InternalServerException There is an internal server error. HTTP Status Code: 500 ThrottlingException There is a throttling error. HTTP Status Code: 429 ValidationException There is a validation error. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin See Also API Version 2020-07-08 97 Amazon WorkSpaces Secure Browser • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2020-07-08 98 API Reference Amazon WorkSpaces Secure Browser DeleteTrustStore Deletes the trust store. Request Syntax DELETE /trustStores/trustStoreArn+ HTTP/1.1 URI Request Parameters The request uses the following URI parameters. trustStoreArn The ARN of the trust store. Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. DeleteTrustStore API Version 2020-07-08 99 API Reference Amazon WorkSpaces Secure Browser AccessDeniedException Access is denied. HTTP Status Code: 403 ConflictException There is a conflict. HTTP Status Code: 409 InternalServerException There is an internal server error. HTTP Status Code: 500 ThrottlingException There is a throttling error. HTTP Status Code: 429 ValidationException There is a validation error. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin See Also API Version 2020-07-08 100 Amazon WorkSpaces Secure Browser • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2020-07-08 101 Amazon WorkSpaces Secure Browser API Reference DeleteUserAccessLoggingSettings Deletes user access logging settings. Request Syntax DELETE /userAccessLoggingSettings/userAccessLoggingSettingsArn+ HTTP/1.1 URI Request Parameters The request uses the following URI parameters. userAccessLoggingSettingsArn The ARN of the user access logging settings. Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. DeleteUserAccessLoggingSettings API Version 2020-07-08 102 API Reference Amazon WorkSpaces Secure Browser AccessDeniedException Access is denied. HTTP Status Code: 403 ConflictException There is a conflict. HTTP Status Code: 409 InternalServerException There is an internal server error. HTTP Status Code: 500 ThrottlingException There is a throttling error. HTTP Status Code: 429 ValidationException There is a validation error. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin See Also API Version 2020-07-08 103 Amazon WorkSpaces Secure Browser • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2020-07-08 104 API Reference Amazon WorkSpaces Secure Browser DeleteUserSettings Deletes user settings. Request Syntax DELETE /userSettings/userSettingsArn+ HTTP/1.1 URI Request Parameters The request uses the following URI parameters. userSettingsArn The ARN of the user settings. Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. DeleteUserSettings API Version 2020-07-08 105 API Reference Amazon WorkSpaces Secure Browser AccessDeniedException Access is denied. HTTP Status Code: 403 ConflictException There is a conflict. HTTP Status Code: 409 |
workspacesweb-api-020 | workspacesweb-api.pdf | 20 | parameters. userSettingsArn The ARN of the user settings. Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. DeleteUserSettings API Version 2020-07-08 105 API Reference Amazon WorkSpaces Secure Browser AccessDeniedException Access is denied. HTTP Status Code: 403 ConflictException There is a conflict. HTTP Status Code: 409 InternalServerException There is an internal server error. HTTP Status Code: 500 ThrottlingException There is a throttling error. HTTP Status Code: 429 ValidationException There is a validation error. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin See Also API Version 2020-07-08 106 Amazon WorkSpaces Secure Browser • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2020-07-08 107 Amazon WorkSpaces Secure Browser API Reference DisassociateBrowserSettings Disassociates browser settings from a web portal. Request Syntax DELETE /portals/portalArn+/browserSettings HTTP/1.1 URI Request Parameters The request uses the following URI parameters. portalArn The ARN of the web portal. Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. DisassociateBrowserSettings API Version 2020-07-08 108 API Reference Amazon WorkSpaces Secure Browser AccessDeniedException Access is denied. HTTP Status Code: 403 ConflictException There is a conflict. HTTP Status Code: 409 InternalServerException There is an internal server error. HTTP Status Code: 500 ResourceNotFoundException The resource cannot be found. HTTP Status Code: 404 ThrottlingException There is a throttling error. HTTP Status Code: 429 ValidationException There is a validation error. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ See Also API Version 2020-07-08 109 Amazon WorkSpaces Secure Browser • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2020-07-08 110 Amazon WorkSpaces Secure Browser API Reference DisassociateDataProtectionSettings Disassociates data protection settings from a web portal. Request Syntax DELETE /portals/portalArn+/dataProtectionSettings HTTP/1.1 URI Request Parameters The request uses the following URI parameters. portalArn The ARN of the web portal. Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. DisassociateDataProtectionSettings API Version 2020-07-08 111 API Reference Amazon WorkSpaces Secure Browser AccessDeniedException Access is denied. HTTP Status Code: 403 ConflictException There is a conflict. HTTP Status Code: 409 InternalServerException There is an internal server error. HTTP Status Code: 500 ResourceNotFoundException The resource cannot be found. HTTP Status Code: 404 ThrottlingException There is a throttling error. HTTP Status Code: 429 ValidationException There is a validation error. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ See Also API Version 2020-07-08 112 Amazon WorkSpaces Secure Browser • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2020-07-08 113 Amazon WorkSpaces Secure Browser API Reference DisassociateIpAccessSettings Disassociates IP access settings from a web portal. Request Syntax DELETE /portals/portalArn+/ipAccessSettings HTTP/1.1 URI Request Parameters The request uses the following URI parameters. portalArn The ARN of the web portal. Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ Required: Yes Request Body |
workspacesweb-api-021 | workspacesweb-api.pdf | 21 | SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2020-07-08 113 Amazon WorkSpaces Secure Browser API Reference DisassociateIpAccessSettings Disassociates IP access settings from a web portal. Request Syntax DELETE /portals/portalArn+/ipAccessSettings HTTP/1.1 URI Request Parameters The request uses the following URI parameters. portalArn The ARN of the web portal. Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. DisassociateIpAccessSettings API Version 2020-07-08 114 API Reference Amazon WorkSpaces Secure Browser AccessDeniedException Access is denied. HTTP Status Code: 403 ConflictException There is a conflict. HTTP Status Code: 409 InternalServerException There is an internal server error. HTTP Status Code: 500 ResourceNotFoundException The resource cannot be found. HTTP Status Code: 404 ThrottlingException There is a throttling error. HTTP Status Code: 429 ValidationException There is a validation error. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ See Also API Version 2020-07-08 115 Amazon WorkSpaces Secure Browser • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2020-07-08 116 Amazon WorkSpaces Secure Browser API Reference DisassociateNetworkSettings Disassociates network settings from a web portal. Request Syntax DELETE /portals/portalArn+/networkSettings HTTP/1.1 URI Request Parameters The request uses the following URI parameters. portalArn The ARN of the web portal. Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. DisassociateNetworkSettings API Version 2020-07-08 117 API Reference Amazon WorkSpaces Secure Browser AccessDeniedException Access is denied. HTTP Status Code: 403 ConflictException There is a conflict. HTTP Status Code: 409 InternalServerException There is an internal server error. HTTP Status Code: 500 ResourceNotFoundException The resource cannot be found. HTTP Status Code: 404 ThrottlingException There is a throttling error. HTTP Status Code: 429 ValidationException There is a validation error. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ See Also API Version 2020-07-08 118 Amazon WorkSpaces Secure Browser • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2020-07-08 119 Amazon WorkSpaces Secure Browser API Reference DisassociateTrustStore Disassociates a trust store from a web portal. Request Syntax DELETE /portals/portalArn+/trustStores HTTP/1.1 URI Request Parameters The request uses the following URI parameters. portalArn The ARN of the web portal. Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. DisassociateTrustStore API Version 2020-07-08 120 API Reference Amazon WorkSpaces Secure Browser AccessDeniedException Access is denied. HTTP Status Code: 403 ConflictException There is a conflict. HTTP Status Code: 409 InternalServerException There is an internal server error. HTTP Status Code: 500 ResourceNotFoundException The resource cannot be found. HTTP Status Code: 404 ThrottlingException There is a throttling error. HTTP Status Code: 429 ValidationException There is a validation error. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ See Also API Version 2020-07-08 121 Amazon WorkSpaces Secure Browser • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript |
workspacesweb-api-022 | workspacesweb-api.pdf | 22 | is an internal server error. HTTP Status Code: 500 ResourceNotFoundException The resource cannot be found. HTTP Status Code: 404 ThrottlingException There is a throttling error. HTTP Status Code: 429 ValidationException There is a validation error. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ See Also API Version 2020-07-08 121 Amazon WorkSpaces Secure Browser • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2020-07-08 122 Amazon WorkSpaces Secure Browser API Reference DisassociateUserAccessLoggingSettings Disassociates user access logging settings from a web portal. Request Syntax DELETE /portals/portalArn+/userAccessLoggingSettings HTTP/1.1 URI Request Parameters The request uses the following URI parameters. portalArn The ARN of the web portal. Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. DisassociateUserAccessLoggingSettings API Version 2020-07-08 123 API Reference Amazon WorkSpaces Secure Browser AccessDeniedException Access is denied. HTTP Status Code: 403 ConflictException There is a conflict. HTTP Status Code: 409 InternalServerException There is an internal server error. HTTP Status Code: 500 ResourceNotFoundException The resource cannot be found. HTTP Status Code: 404 ThrottlingException There is a throttling error. HTTP Status Code: 429 ValidationException There is a validation error. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ See Also API Version 2020-07-08 124 Amazon WorkSpaces Secure Browser • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2020-07-08 125 Amazon WorkSpaces Secure Browser API Reference DisassociateUserSettings Disassociates user settings from a web portal. Request Syntax DELETE /portals/portalArn+/userSettings HTTP/1.1 URI Request Parameters The request uses the following URI parameters. portalArn The ARN of the web portal. Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. DisassociateUserSettings API Version 2020-07-08 126 API Reference Amazon WorkSpaces Secure Browser AccessDeniedException Access is denied. HTTP Status Code: 403 ConflictException There is a conflict. HTTP Status Code: 409 InternalServerException There is an internal server error. HTTP Status Code: 500 ResourceNotFoundException The resource cannot be found. HTTP Status Code: 404 ThrottlingException There is a throttling error. HTTP Status Code: 429 ValidationException There is a validation error. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ See Also API Version 2020-07-08 127 Amazon WorkSpaces Secure Browser • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2020-07-08 128 Amazon WorkSpaces Secure Browser ExpireSession Expires an active secure browser session. Request Syntax DELETE /portals/portalId/sessions/sessionId HTTP/1.1 API Reference URI Request Parameters The request uses the following URI parameters. portalId The ID of the web portal for the session. Length Constraints: Fixed length of 36. Pattern: ^[a-zA-Z0-9\-]+$ Required: Yes sessionId The ID of the session to expire. Length Constraints: Fixed length of 36. Pattern: ^[a-zA-Z0-9\-]+$ Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 ExpireSession API Version 2020-07-08 129 Amazon WorkSpaces Secure Browser Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Access is denied. HTTP Status Code: 403 InternalServerException There is an internal server error. HTTP Status Code: 500 |
workspacesweb-api-023 | workspacesweb-api.pdf | 23 | ^[a-zA-Z0-9\-]+$ Required: Yes sessionId The ID of the session to expire. Length Constraints: Fixed length of 36. Pattern: ^[a-zA-Z0-9\-]+$ Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 ExpireSession API Version 2020-07-08 129 Amazon WorkSpaces Secure Browser Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Access is denied. HTTP Status Code: 403 InternalServerException There is an internal server error. HTTP Status Code: 500 ResourceNotFoundException The resource cannot be found. HTTP Status Code: 404 ThrottlingException There is a throttling error. HTTP Status Code: 429 ValidationException There is a validation error. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface Response Elements API Version 2020-07-08 130 API Reference Amazon WorkSpaces Secure Browser • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-07-08 131 API Reference Amazon WorkSpaces Secure Browser GetBrowserSettings Gets browser settings. Request Syntax GET /browserSettings/browserSettingsArn+ HTTP/1.1 URI Request Parameters The request uses the following URI parameters. browserSettingsArn The ARN of the browser settings. Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "browserSettings": { "additionalEncryptionContext": { "string" : "string" }, "associatedPortalArns": [ "string" ], "browserPolicy": "string", "browserSettingsArn": "string", GetBrowserSettings API Version 2020-07-08 132 Amazon WorkSpaces Secure Browser API Reference "customerManagedKey": "string" } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. browserSettings The browser settings. Type: BrowserSettings object Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Access is denied. HTTP Status Code: 403 InternalServerException There is an internal server error. HTTP Status Code: 500 ResourceNotFoundException The resource cannot be found. HTTP Status Code: 404 ThrottlingException There is a throttling error. HTTP Status Code: 429 Response Elements API Version 2020-07-08 133 Amazon WorkSpaces Secure Browser ValidationException There is a validation error. HTTP Status Code: 400 See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-07-08 134 Amazon WorkSpaces Secure Browser API Reference GetDataProtectionSettings Gets the data protection settings. Request Syntax GET /dataProtectionSettings/dataProtectionSettingsArn+ HTTP/1.1 URI Request Parameters The request uses the following URI parameters. dataProtectionSettingsArn The ARN of the data protection settings. Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "dataProtectionSettings": { "additionalEncryptionContext": { "string" : "string" }, "associatedPortalArns": [ "string" ], "creationDate": number, "customerManagedKey": "string", "dataProtectionSettingsArn": "string", GetDataProtectionSettings API Version 2020-07-08 135 Amazon WorkSpaces Secure Browser API Reference "description": "string", "displayName": "string", "inlineRedactionConfiguration": { "globalConfidenceLevel": number, "globalEnforcedUrls": [ "string" ], "globalExemptUrls": [ "string" ], "inlineRedactionPatterns": [ { "builtInPatternId": "string", "confidenceLevel": number, "customPattern": { "keywordRegex": "string", "patternDescription": "string", "patternName": "string", "patternRegex": "string" }, "enforcedUrls": [ "string" ], "exemptUrls": [ "string" ], "redactionPlaceHolder": { "redactionPlaceHolderText": "string", "redactionPlaceHolderType": "string" } } ] } } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. dataProtectionSettings The data protection settings. Type: DataProtectionSettings object Errors For information about the errors that are common to all actions, see Common Errors. Response Elements API Version 2020-07-08 136 API Reference Amazon WorkSpaces Secure Browser AccessDeniedException Access is denied. HTTP Status Code: 403 InternalServerException There is an internal server error. HTTP Status Code: 500 ResourceNotFoundException The resource cannot be found. HTTP Status Code: 404 ThrottlingException There is a throttling error. HTTP Status Code: 429 ValidationException There is a validation error. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ |
workspacesweb-api-024 | workspacesweb-api.pdf | 24 | all actions, see Common Errors. Response Elements API Version 2020-07-08 136 API Reference Amazon WorkSpaces Secure Browser AccessDeniedException Access is denied. HTTP Status Code: 403 InternalServerException There is an internal server error. HTTP Status Code: 500 ResourceNotFoundException The resource cannot be found. HTTP Status Code: 404 ThrottlingException There is a throttling error. HTTP Status Code: 429 ValidationException There is a validation error. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin See Also API Version 2020-07-08 137 Amazon WorkSpaces Secure Browser • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2020-07-08 138 API Reference Amazon WorkSpaces Secure Browser GetIdentityProvider Gets the identity provider. Request Syntax GET /identityProviders/identityProviderArn+ HTTP/1.1 URI Request Parameters The request uses the following URI parameters. identityProviderArn The ARN of the identity provider. Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36}){2,}$ Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "identityProvider": { "identityProviderArn": "string", "identityProviderDetails": { "string" : "string" }, "identityProviderName": "string", GetIdentityProvider API Version 2020-07-08 139 Amazon WorkSpaces Secure Browser API Reference "identityProviderType": "string" } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. identityProvider The identity provider. Type: IdentityProvider object Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Access is denied. HTTP Status Code: 403 InternalServerException There is an internal server error. HTTP Status Code: 500 ResourceNotFoundException The resource cannot be found. HTTP Status Code: 404 ThrottlingException There is a throttling error. HTTP Status Code: 429 Response Elements API Version 2020-07-08 140 Amazon WorkSpaces Secure Browser ValidationException There is a validation error. HTTP Status Code: 400 See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-07-08 141 Amazon WorkSpaces Secure Browser API Reference GetIpAccessSettings Gets the IP access settings. Request Syntax GET /ipAccessSettings/ipAccessSettingsArn+ HTTP/1.1 URI Request Parameters The request uses the following URI parameters. ipAccessSettingsArn The ARN of the IP access settings. Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "ipAccessSettings": { "additionalEncryptionContext": { "string" : "string" }, "associatedPortalArns": [ "string" ], "creationDate": number, "customerManagedKey": "string", GetIpAccessSettings API Version 2020-07-08 142 Amazon WorkSpaces Secure Browser API Reference "description": "string", "displayName": "string", "ipAccessSettingsArn": "string", "ipRules": [ { "description": "string", "ipRange": "string" } ] } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ipAccessSettings The IP access settings. Type: IpAccessSettings object Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Access is denied. HTTP Status Code: 403 InternalServerException There is an internal server error. HTTP Status Code: 500 ResourceNotFoundException The resource cannot be found. Response Elements API Version 2020-07-08 143 API Reference Amazon WorkSpaces Secure Browser HTTP Status Code: 404 ThrottlingException There is a throttling error. HTTP Status Code: 429 ValidationException There is a validation error. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-07-08 144 Amazon WorkSpaces Secure Browser API Reference GetNetworkSettings Gets the network settings. Request Syntax GET /networkSettings/networkSettingsArn+ HTTP/1.1 URI Request Parameters The request uses the following URI parameters. networkSettingsArn The ARN of the network settings. Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ Required: Yes Request Body The request does not have a request body. Response Syntax |
workspacesweb-api-025 | workspacesweb-api.pdf | 25 | • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-07-08 144 Amazon WorkSpaces Secure Browser API Reference GetNetworkSettings Gets the network settings. Request Syntax GET /networkSettings/networkSettingsArn+ HTTP/1.1 URI Request Parameters The request uses the following URI parameters. networkSettingsArn The ARN of the network settings. Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "networkSettings": { "associatedPortalArns": [ "string" ], "networkSettingsArn": "string", "securityGroupIds": [ "string" ], "subnetIds": [ "string" ], "vpcId": "string" } GetNetworkSettings API Version 2020-07-08 145 Amazon WorkSpaces Secure Browser API Reference } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. networkSettings The network settings. Type: NetworkSettings object Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Access is denied. HTTP Status Code: 403 InternalServerException There is an internal server error. HTTP Status Code: 500 ResourceNotFoundException The resource cannot be found. HTTP Status Code: 404 ThrottlingException There is a throttling error. HTTP Status Code: 429 ValidationException There is a validation error. Response Elements API Version 2020-07-08 146 Amazon WorkSpaces Secure Browser HTTP Status Code: 400 See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-07-08 147 Amazon WorkSpaces Secure Browser API Reference GetPortal Gets the web portal. Request Syntax GET /portals/portalArn+ HTTP/1.1 URI Request Parameters The request uses the following URI parameters. portalArn The ARN of the web portal. Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "portal": { "additionalEncryptionContext": { "string" : "string" }, "authenticationType": "string", "browserSettingsArn": "string", "browserType": "string", "creationDate": number, GetPortal API Version 2020-07-08 148 Amazon WorkSpaces Secure Browser API Reference "customerManagedKey": "string", "dataProtectionSettingsArn": "string", "displayName": "string", "instanceType": "string", "ipAccessSettingsArn": "string", "maxConcurrentSessions": number, "networkSettingsArn": "string", "portalArn": "string", "portalEndpoint": "string", "portalStatus": "string", "rendererType": "string", "statusReason": "string", "trustStoreArn": "string", "userAccessLoggingSettingsArn": "string", "userSettingsArn": "string" } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. portal The web portal. Type: Portal object Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Access is denied. HTTP Status Code: 403 InternalServerException There is an internal server error. Response Elements API Version 2020-07-08 149 API Reference Amazon WorkSpaces Secure Browser HTTP Status Code: 500 ResourceNotFoundException The resource cannot be found. HTTP Status Code: 404 ThrottlingException There is a throttling error. HTTP Status Code: 429 ValidationException There is a validation error. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-07-08 150 Amazon WorkSpaces Secure Browser API Reference GetPortalServiceProviderMetadata Gets the service provider metadata. Request Syntax GET /portalIdp/portalArn+ HTTP/1.1 URI Request Parameters The request uses the following URI parameters. portalArn The ARN of the web portal. Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "portalArn": "string", "serviceProviderSamlMetadata": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. GetPortalServiceProviderMetadata API Version 2020-07-08 151 Amazon WorkSpaces Secure Browser API Reference The following data is returned in JSON format by the service. portalArn The ARN of the web portal. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ serviceProviderSamlMetadata The service provider SAML metadata. Type: String Length Constraints: Minimum length of 1. Maximum length of 204800. Pattern: ^.+$ Errors For information about the errors that are common to all actions, |
workspacesweb-api-026 | workspacesweb-api.pdf | 26 | 200 Content-type: application/json { "portalArn": "string", "serviceProviderSamlMetadata": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. GetPortalServiceProviderMetadata API Version 2020-07-08 151 Amazon WorkSpaces Secure Browser API Reference The following data is returned in JSON format by the service. portalArn The ARN of the web portal. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ serviceProviderSamlMetadata The service provider SAML metadata. Type: String Length Constraints: Minimum length of 1. Maximum length of 204800. Pattern: ^.+$ Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Access is denied. HTTP Status Code: 403 InternalServerException There is an internal server error. HTTP Status Code: 500 ResourceNotFoundException The resource cannot be found. HTTP Status Code: 404 Errors API Version 2020-07-08 152 API Reference Amazon WorkSpaces Secure Browser ThrottlingException There is a throttling error. HTTP Status Code: 429 ValidationException There is a validation error. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-07-08 153 API Reference Amazon WorkSpaces Secure Browser GetSession Gets information for a secure browser session. Request Syntax GET /portals/portalId/sessions/sessionId HTTP/1.1 URI Request Parameters The request uses the following URI parameters. portalId The ID of the web portal for the session. Length Constraints: Fixed length of 36. Pattern: ^[a-zA-Z0-9\-]+$ Required: Yes sessionId The ID of the session. Length Constraints: Fixed length of 36. Pattern: ^[a-zA-Z0-9\-]+$ Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json GetSession API Version 2020-07-08 154 Amazon WorkSpaces Secure Browser API Reference { "session": { "clientIpAddresses": [ "string" ], "endTime": number, "portalArn": "string", "sessionId": "string", "startTime": number, "status": "string", "username": "string" } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. session The sessions in a list. Type: Session object Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Access is denied. HTTP Status Code: 403 InternalServerException There is an internal server error. HTTP Status Code: 500 ResourceNotFoundException The resource cannot be found. Response Elements API Version 2020-07-08 155 API Reference Amazon WorkSpaces Secure Browser HTTP Status Code: 404 ThrottlingException There is a throttling error. HTTP Status Code: 429 ValidationException There is a validation error. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-07-08 156 API Reference Amazon WorkSpaces Secure Browser GetTrustStore Gets the trust store. Request Syntax GET /trustStores/trustStoreArn+ HTTP/1.1 URI Request Parameters The request uses the following URI parameters. trustStoreArn The ARN of the trust store. Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "trustStore": { "associatedPortalArns": [ "string" ], "trustStoreArn": "string" } } GetTrustStore API Version 2020-07-08 157 Amazon WorkSpaces Secure Browser Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. trustStore The trust store. Type: TrustStore object Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Access is denied. HTTP Status Code: 403 InternalServerException There is an internal server error. HTTP Status Code: 500 ResourceNotFoundException The resource cannot be found. HTTP Status Code: 404 ThrottlingException There is a throttling error. HTTP Status Code: 429 ValidationException There is a validation error. HTTP Status Code: 400 Response Elements API Version 2020-07-08 158 Amazon WorkSpaces Secure Browser API Reference See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • |
workspacesweb-api-027 | workspacesweb-api.pdf | 27 | ResourceNotFoundException The resource cannot be found. HTTP Status Code: 404 ThrottlingException There is a throttling error. HTTP Status Code: 429 ValidationException There is a validation error. HTTP Status Code: 400 Response Elements API Version 2020-07-08 158 Amazon WorkSpaces Secure Browser API Reference See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-07-08 159 Amazon WorkSpaces Secure Browser API Reference GetTrustStoreCertificate Gets the trust store certificate. Request Syntax GET /trustStores/trustStoreArn+/certificate?thumbprint=thumbprint HTTP/1.1 URI Request Parameters The request uses the following URI parameters. thumbprint The thumbprint of the trust store certificate. Length Constraints: Fixed length of 64. Pattern: ^[A-Fa-f0-9]{64}$ Required: Yes trustStoreArn The ARN of the trust store certificate. Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json GetTrustStoreCertificate API Version 2020-07-08 160 Amazon WorkSpaces Secure Browser API Reference { "certificate": { "body": blob, "issuer": "string", "notValidAfter": number, "notValidBefore": number, "subject": "string", "thumbprint": "string" }, "trustStoreArn": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. certificate The certificate of the trust store certificate. Type: Certificate object trustStoreArn The ARN of the trust store certificate. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Access is denied. Response Elements API Version 2020-07-08 161 API Reference Amazon WorkSpaces Secure Browser HTTP Status Code: 403 InternalServerException There is an internal server error. HTTP Status Code: 500 ResourceNotFoundException The resource cannot be found. HTTP Status Code: 404 ThrottlingException There is a throttling error. HTTP Status Code: 429 ValidationException There is a validation error. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-07-08 162 Amazon WorkSpaces Secure Browser API Reference See Also API Version 2020-07-08 163 Amazon WorkSpaces Secure Browser API Reference GetUserAccessLoggingSettings Gets user access logging settings. Request Syntax GET /userAccessLoggingSettings/userAccessLoggingSettingsArn+ HTTP/1.1 URI Request Parameters The request uses the following URI parameters. userAccessLoggingSettingsArn The ARN of the user access logging settings. Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "userAccessLoggingSettings": { "associatedPortalArns": [ "string" ], "kinesisStreamArn": "string", "userAccessLoggingSettingsArn": "string" } } GetUserAccessLoggingSettings API Version 2020-07-08 164 Amazon WorkSpaces Secure Browser Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. userAccessLoggingSettings The user access logging settings. Type: UserAccessLoggingSettings object Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Access is denied. HTTP Status Code: 403 InternalServerException There is an internal server error. HTTP Status Code: 500 ResourceNotFoundException The resource cannot be found. HTTP Status Code: 404 ThrottlingException There is a throttling error. HTTP Status Code: 429 ValidationException There is a validation error. HTTP Status Code: 400 Response Elements API Version 2020-07-08 165 Amazon WorkSpaces Secure Browser API Reference See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-07-08 166 API Reference Amazon WorkSpaces Secure Browser GetUserSettings Gets user settings. Request Syntax GET /userSettings/userSettingsArn+ HTTP/1.1 URI Request Parameters The request uses the following URI parameters. userSettingsArn The ARN of the user settings. Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ Required: Yes Request Body The request does not have |
workspacesweb-api-028 | workspacesweb-api.pdf | 28 | • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-07-08 166 API Reference Amazon WorkSpaces Secure Browser GetUserSettings Gets user settings. Request Syntax GET /userSettings/userSettingsArn+ HTTP/1.1 URI Request Parameters The request uses the following URI parameters. userSettingsArn The ARN of the user settings. Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "userSettings": { "additionalEncryptionContext": { "string" : "string" }, "associatedPortalArns": [ "string" ], "cookieSynchronizationConfiguration": { "allowlist": [ { GetUserSettings API Version 2020-07-08 167 Amazon WorkSpaces Secure Browser API Reference "domain": "string", "name": "string", "path": "string" } ], "blocklist": [ { "domain": "string", "name": "string", "path": "string" } ] }, "copyAllowed": "string", "customerManagedKey": "string", "deepLinkAllowed": "string", "disconnectTimeoutInMinutes": number, "downloadAllowed": "string", "idleDisconnectTimeoutInMinutes": number, "pasteAllowed": "string", "printAllowed": "string", "toolbarConfiguration": { "hiddenToolbarItems": [ "string" ], "maxDisplayResolution": "string", "toolbarType": "string", "visualMode": "string" }, "uploadAllowed": "string", "userSettingsArn": "string" } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. userSettings The user settings. Type: UserSettings object Response Elements API Version 2020-07-08 168 Amazon WorkSpaces Secure Browser API Reference Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Access is denied. HTTP Status Code: 403 InternalServerException There is an internal server error. HTTP Status Code: 500 ResourceNotFoundException The resource cannot be found. HTTP Status Code: 404 ThrottlingException There is a throttling error. HTTP Status Code: 429 ValidationException There is a validation error. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 Errors API Version 2020-07-08 169 Amazon WorkSpaces Secure Browser • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2020-07-08 170 Amazon WorkSpaces Secure Browser ListBrowserSettings Retrieves a list of browser settings. Request Syntax API Reference GET /browserSettings?maxResults=maxResults&nextToken=nextToken HTTP/1.1 URI Request Parameters The request uses the following URI parameters. maxResults The maximum number of results to be included in the next page. Valid Range: Minimum value of 1. nextToken The pagination token used to retrieve the next page of results for this operation. Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: ^\S+$ Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "browserSettings": [ { "browserSettingsArn": "string" } ], ListBrowserSettings API Version 2020-07-08 171 Amazon WorkSpaces Secure Browser "nextToken": "string" } Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. browserSettings The browser settings. Type: Array of BrowserSettingsSummary objects nextToken The pagination token used to retrieve the next page of results for this operation. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: ^\S+$ Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Access is denied. HTTP Status Code: 403 InternalServerException There is an internal server error. HTTP Status Code: 500 ThrottlingException There is a throttling error. Response Elements API Version 2020-07-08 172 Amazon WorkSpaces Secure Browser HTTP Status Code: 429 ValidationException There is a validation error. HTTP Status Code: 400 See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-07-08 173 Amazon WorkSpaces Secure Browser API Reference ListDataProtectionSettings Retrieves a list of data protection settings. Request Syntax GET /dataProtectionSettings?maxResults=maxResults&nextToken=nextToken HTTP/1.1 URI Request Parameters The request uses the following URI parameters. maxResults The maximum number of results to be included in the next page. Valid Range: Minimum value of 1. nextToken The pagination token used to retrieve the next page of results for this operation. Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: ^\S+$ Request Body The request does not have a request body. |
workspacesweb-api-029 | workspacesweb-api.pdf | 29 | SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-07-08 173 Amazon WorkSpaces Secure Browser API Reference ListDataProtectionSettings Retrieves a list of data protection settings. Request Syntax GET /dataProtectionSettings?maxResults=maxResults&nextToken=nextToken HTTP/1.1 URI Request Parameters The request uses the following URI parameters. maxResults The maximum number of results to be included in the next page. Valid Range: Minimum value of 1. nextToken The pagination token used to retrieve the next page of results for this operation. Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: ^\S+$ Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "dataProtectionSettings": [ { "creationDate": number, "dataProtectionSettingsArn": "string", "description": "string", ListDataProtectionSettings API Version 2020-07-08 174 Amazon WorkSpaces Secure Browser API Reference "displayName": "string" } ], "nextToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. dataProtectionSettings The data protection settings. Type: Array of DataProtectionSettingsSummary objects nextToken The pagination token used to retrieve the next page of results for this operation. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: ^\S+$ Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Access is denied. HTTP Status Code: 403 InternalServerException There is an internal server error. HTTP Status Code: 500 Response Elements API Version 2020-07-08 175 API Reference Amazon WorkSpaces Secure Browser ThrottlingException There is a throttling error. HTTP Status Code: 429 ValidationException There is a validation error. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-07-08 176 Amazon WorkSpaces Secure Browser API Reference ListIdentityProviders Retrieves a list of identity providers for a specific web portal. Request Syntax GET /portals/portalArn+/identityProviders?maxResults=maxResults&nextToken=nextToken HTTP/1.1 URI Request Parameters The request uses the following URI parameters. maxResults The maximum number of results to be included in the next page. Valid Range: Minimum value of 1. nextToken The pagination token used to retrieve the next page of results for this operation. Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: ^\S+$ portalArn The ARN of the web portal. Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ Required: Yes Request Body The request does not have a request body. ListIdentityProviders API Version 2020-07-08 177 API Reference Amazon WorkSpaces Secure Browser Response Syntax HTTP/1.1 200 Content-type: application/json { "identityProviders": [ { "identityProviderArn": "string", "identityProviderName": "string", "identityProviderType": "string" } ], "nextToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. identityProviders The identity providers. Type: Array of IdentityProviderSummary objects nextToken The pagination token used to retrieve the next page of results for this operation. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: ^\S+$ Errors For information about the errors that are common to all actions, see Common Errors. Response Syntax API Version 2020-07-08 178 API Reference Amazon WorkSpaces Secure Browser AccessDeniedException Access is denied. HTTP Status Code: 403 InternalServerException There is an internal server error. HTTP Status Code: 500 ThrottlingException There is a throttling error. HTTP Status Code: 429 ValidationException There is a validation error. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-07-08 179 Amazon WorkSpaces Secure Browser API Reference ListIpAccessSettings Retrieves a list of IP access settings. Request Syntax GET /ipAccessSettings?maxResults=maxResults&nextToken=nextToken HTTP/1.1 URI Request Parameters The request uses the following URI parameters. maxResults The maximum number of results to be included in the next page. Valid Range: Minimum value of 1. nextToken The pagination token used to retrieve the next page of results for this operation. Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: ^\S+$ Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "ipAccessSettings": [ { "creationDate": number, "description": "string", "displayName": "string", ListIpAccessSettings |
workspacesweb-api-030 | workspacesweb-api.pdf | 30 | Secure Browser API Reference ListIpAccessSettings Retrieves a list of IP access settings. Request Syntax GET /ipAccessSettings?maxResults=maxResults&nextToken=nextToken HTTP/1.1 URI Request Parameters The request uses the following URI parameters. maxResults The maximum number of results to be included in the next page. Valid Range: Minimum value of 1. nextToken The pagination token used to retrieve the next page of results for this operation. Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: ^\S+$ Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "ipAccessSettings": [ { "creationDate": number, "description": "string", "displayName": "string", ListIpAccessSettings API Version 2020-07-08 180 Amazon WorkSpaces Secure Browser API Reference "ipAccessSettingsArn": "string" } ], "nextToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ipAccessSettings The IP access settings. Type: Array of IpAccessSettingsSummary objects nextToken The pagination token used to retrieve the next page of results for this operation. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: ^\S+$ Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Access is denied. HTTP Status Code: 403 InternalServerException There is an internal server error. HTTP Status Code: 500 Response Elements API Version 2020-07-08 181 API Reference Amazon WorkSpaces Secure Browser ThrottlingException There is a throttling error. HTTP Status Code: 429 ValidationException There is a validation error. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-07-08 182 Amazon WorkSpaces Secure Browser API Reference ListNetworkSettings Retrieves a list of network settings. Request Syntax GET /networkSettings?maxResults=maxResults&nextToken=nextToken HTTP/1.1 URI Request Parameters The request uses the following URI parameters. maxResults The maximum number of results to be included in the next page. Valid Range: Minimum value of 1. nextToken The pagination token used to retrieve the next page of results for this operation. Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: ^\S+$ Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "networkSettings": [ { "networkSettingsArn": "string", "vpcId": "string" } ListNetworkSettings API Version 2020-07-08 183 Amazon WorkSpaces Secure Browser ], "nextToken": "string" } Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. networkSettings The network settings. Type: Array of NetworkSettingsSummary objects nextToken The pagination token used to retrieve the next page of results for this operation. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: ^\S+$ Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Access is denied. HTTP Status Code: 403 InternalServerException There is an internal server error. HTTP Status Code: 500 ThrottlingException There is a throttling error. Response Elements API Version 2020-07-08 184 Amazon WorkSpaces Secure Browser HTTP Status Code: 429 ValidationException There is a validation error. HTTP Status Code: 400 See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-07-08 185 Amazon WorkSpaces Secure Browser ListPortals Retrieves a list or web portals. Request Syntax API Reference GET /portals?maxResults=maxResults&nextToken=nextToken HTTP/1.1 URI Request Parameters The request uses the following URI parameters. maxResults The maximum number of results to be included in the next page. Valid Range: Minimum value of 1. nextToken The pagination token used to retrieve the next page of results for this operation. Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: ^\S+$ Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "nextToken": "string", "portals": [ { "authenticationType": "string", "browserSettingsArn": "string", "browserType": "string", ListPortals API Version 2020-07-08 186 Amazon WorkSpaces Secure Browser API Reference "creationDate": number, "dataProtectionSettingsArn": "string", "displayName": "string", "instanceType": "string", "ipAccessSettingsArn": "string", "maxConcurrentSessions": number, "networkSettingsArn": "string", "portalArn": "string", "portalEndpoint": "string", "portalStatus": "string", "rendererType": "string", "trustStoreArn": "string", "userAccessLoggingSettingsArn": "string", "userSettingsArn": "string" } ] } Response Elements If the |
workspacesweb-api-031 | workspacesweb-api.pdf | 31 | The pagination token used to retrieve the next page of results for this operation. Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: ^\S+$ Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "nextToken": "string", "portals": [ { "authenticationType": "string", "browserSettingsArn": "string", "browserType": "string", ListPortals API Version 2020-07-08 186 Amazon WorkSpaces Secure Browser API Reference "creationDate": number, "dataProtectionSettingsArn": "string", "displayName": "string", "instanceType": "string", "ipAccessSettingsArn": "string", "maxConcurrentSessions": number, "networkSettingsArn": "string", "portalArn": "string", "portalEndpoint": "string", "portalStatus": "string", "rendererType": "string", "trustStoreArn": "string", "userAccessLoggingSettingsArn": "string", "userSettingsArn": "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. nextToken The pagination token used to retrieve the next page of results for this operation. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: ^\S+$ portals The portals in the list. Type: Array of PortalSummary objects Errors For information about the errors that are common to all actions, see Common Errors. Response Elements API Version 2020-07-08 187 API Reference Amazon WorkSpaces Secure Browser AccessDeniedException Access is denied. HTTP Status Code: 403 InternalServerException There is an internal server error. HTTP Status Code: 500 ThrottlingException There is a throttling error. HTTP Status Code: 429 ValidationException There is a validation error. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-07-08 188 Amazon WorkSpaces Secure Browser ListSessions API Reference Lists information for multiple secure browser sessions from a specific portal. Request Syntax GET /portals/portalId/sessions? maxResults=maxResults&nextToken=nextToken&sessionId=sessionId&sortBy=sortBy&status=status&username=username HTTP/1.1 URI Request Parameters The request uses the following URI parameters. maxResults The maximum number of results to be included in the next page. Valid Range: Minimum value of 1. nextToken The pagination token used to retrieve the next page of results for this operation. Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: ^\S+$ portalId The ID of the web portal for the sessions. Length Constraints: Fixed length of 36. Pattern: ^[a-zA-Z0-9\-]+$ Required: Yes sessionId The ID of the session. Length Constraints: Fixed length of 36. ListSessions API Version 2020-07-08 189 Amazon WorkSpaces Secure Browser API Reference Pattern: ^[a-zA-Z0-9\-]+$ sortBy The method in which the returned sessions should be sorted. Valid Values: StartTimeAscending | StartTimeDescending status The status of the session. Valid Values: Active | Terminated username The username of the session. Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: ^[\s\S]*$ Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "nextToken": "string", "sessions": [ { "endTime": number, "portalArn": "string", "sessionId": "string", "startTime": number, "status": "string", "username": "string" } ] } Request Body API Version 2020-07-08 190 Amazon WorkSpaces Secure Browser Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. nextToken The pagination token used to retrieve the next page of results for this operation. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: ^\S+$ sessions The sessions in a list. Type: Array of SessionSummary objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Access is denied. HTTP Status Code: 403 InternalServerException There is an internal server error. HTTP Status Code: 500 ResourceNotFoundException The resource cannot be found. HTTP Status Code: 404 Response Elements API Version 2020-07-08 191 API Reference Amazon WorkSpaces Secure Browser ThrottlingException There is a throttling error. HTTP Status Code: 429 ValidationException There is a validation error. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-07-08 192 Amazon WorkSpaces Secure Browser API Reference ListTagsForResource Retrieves a list of tags for a resource. Request Syntax GET /tags/resourceArn+ HTTP/1.1 URI Request Parameters The request uses the following URI parameters. resourceArn The ARN of the resource. Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ Required: Yes |
workspacesweb-api-032 | workspacesweb-api.pdf | 32 | SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-07-08 192 Amazon WorkSpaces Secure Browser API Reference ListTagsForResource Retrieves a list of tags for a resource. Request Syntax GET /tags/resourceArn+ HTTP/1.1 URI Request Parameters The request uses the following URI parameters. resourceArn The ARN of the resource. Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "tags": [ { "Key": "string", "Value": "string" } ] } ListTagsForResource API Version 2020-07-08 193 Amazon WorkSpaces Secure Browser Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. tags The tags of the resource. Type: Array of Tag objects Array Members: Minimum number of 0 items. Maximum number of 200 items. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Access is denied. HTTP Status Code: 403 InternalServerException There is an internal server error. HTTP Status Code: 500 ResourceNotFoundException The resource cannot be found. HTTP Status Code: 404 ThrottlingException There is a throttling error. HTTP Status Code: 429 ValidationException There is a validation error. Response Elements API Version 2020-07-08 194 Amazon WorkSpaces Secure Browser HTTP Status Code: 400 See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-07-08 195 Amazon WorkSpaces Secure Browser API Reference ListTrustStoreCertificates Retrieves a list of trust store certificates. Request Syntax GET /trustStores/trustStoreArn+/certificates?maxResults=maxResults&nextToken=nextToken HTTP/1.1 URI Request Parameters The request uses the following URI parameters. maxResults The maximum number of results to be included in the next page. Valid Range: Minimum value of 1. nextToken The pagination token used to retrieve the next page of results for this operation. Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: ^\S+$ trustStoreArn The ARN of the trust store Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ Required: Yes Request Body The request does not have a request body. ListTrustStoreCertificates API Version 2020-07-08 196 API Reference Amazon WorkSpaces Secure Browser Response Syntax HTTP/1.1 200 Content-type: application/json { "certificateList": [ { "issuer": "string", "notValidAfter": number, "notValidBefore": number, "subject": "string", "thumbprint": "string" } ], "nextToken": "string", "trustStoreArn": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. certificateList The certificate list. Type: Array of CertificateSummary objects nextToken The pagination token used to retrieve the next page of results for this operation.> Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: ^\S+$ trustStoreArn The ARN of the trust store. Response Syntax API Version 2020-07-08 197 Amazon WorkSpaces Secure Browser Type: String API Reference Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Access is denied. HTTP Status Code: 403 InternalServerException There is an internal server error. HTTP Status Code: 500 ResourceNotFoundException The resource cannot be found. HTTP Status Code: 404 ThrottlingException There is a throttling error. HTTP Status Code: 429 ValidationException There is a validation error. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: Errors API Version 2020-07-08 198 API Reference Amazon WorkSpaces Secure Browser • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-07-08 199 Amazon WorkSpaces Secure Browser ListTrustStores Retrieves a list of trust stores. Request Syntax API Reference GET /trustStores?maxResults=maxResults&nextToken=nextToken HTTP/1.1 URI Request Parameters The request uses the following URI parameters. maxResults The maximum number of results to be included in the next page. Valid Range: Minimum value of 1. nextToken The pagination token used to retrieve the next page of results |
workspacesweb-api-033 | workspacesweb-api.pdf | 33 | v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-07-08 199 Amazon WorkSpaces Secure Browser ListTrustStores Retrieves a list of trust stores. Request Syntax API Reference GET /trustStores?maxResults=maxResults&nextToken=nextToken HTTP/1.1 URI Request Parameters The request uses the following URI parameters. maxResults The maximum number of results to be included in the next page. Valid Range: Minimum value of 1. nextToken The pagination token used to retrieve the next page of results for this operation. Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: ^\S+$ Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "nextToken": "string", "trustStores": [ { "trustStoreArn": "string" } ListTrustStores API Version 2020-07-08 200 Amazon WorkSpaces Secure Browser API Reference ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. nextToken The pagination token used to retrieve the next page of results for this operation. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: ^\S+$ trustStores The trust stores. Type: Array of TrustStoreSummary objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Access is denied. HTTP Status Code: 403 InternalServerException There is an internal server error. HTTP Status Code: 500 ThrottlingException There is a throttling error. Response Elements API Version 2020-07-08 201 Amazon WorkSpaces Secure Browser HTTP Status Code: 429 ValidationException There is a validation error. HTTP Status Code: 400 See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-07-08 202 Amazon WorkSpaces Secure Browser API Reference ListUserAccessLoggingSettings Retrieves a list of user access logging settings. Request Syntax GET /userAccessLoggingSettings?maxResults=maxResults&nextToken=nextToken HTTP/1.1 URI Request Parameters The request uses the following URI parameters. maxResults The maximum number of results to be included in the next page. Valid Range: Minimum value of 1. nextToken The pagination token used to retrieve the next page of results for this operation. Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: ^\S+$ Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "nextToken": "string", "userAccessLoggingSettings": [ { "kinesisStreamArn": "string", "userAccessLoggingSettingsArn": "string" ListUserAccessLoggingSettings API Version 2020-07-08 203 Amazon WorkSpaces Secure Browser API Reference } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. nextToken The pagination token used to retrieve the next page of results for this operation. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: ^\S+$ userAccessLoggingSettings The user access logging settings. Type: Array of UserAccessLoggingSettingsSummary objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Access is denied. HTTP Status Code: 403 InternalServerException There is an internal server error. HTTP Status Code: 500 ThrottlingException There is a throttling error. Response Elements API Version 2020-07-08 204 Amazon WorkSpaces Secure Browser HTTP Status Code: 429 ValidationException There is a validation error. HTTP Status Code: 400 See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-07-08 205 Amazon WorkSpaces Secure Browser ListUserSettings Retrieves a list of user settings. Request Syntax API Reference GET /userSettings?maxResults=maxResults&nextToken=nextToken HTTP/1.1 URI Request Parameters The request uses the following URI parameters. maxResults The maximum number of results to be included in the next page. Valid Range: Minimum value of 1. nextToken The pagination token used to retrieve the next page of results for this operation. Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: ^\S+$ Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "nextToken": "string", "userSettings": [ { "cookieSynchronizationConfiguration": { ListUserSettings API Version 2020-07-08 206 Amazon WorkSpaces Secure Browser API Reference |
workspacesweb-api-034 | workspacesweb-api.pdf | 34 | user settings. Request Syntax API Reference GET /userSettings?maxResults=maxResults&nextToken=nextToken HTTP/1.1 URI Request Parameters The request uses the following URI parameters. maxResults The maximum number of results to be included in the next page. Valid Range: Minimum value of 1. nextToken The pagination token used to retrieve the next page of results for this operation. Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: ^\S+$ Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "nextToken": "string", "userSettings": [ { "cookieSynchronizationConfiguration": { ListUserSettings API Version 2020-07-08 206 Amazon WorkSpaces Secure Browser API Reference "allowlist": [ { "domain": "string", "name": "string", "path": "string" } ], "blocklist": [ { "domain": "string", "name": "string", "path": "string" } ] }, "copyAllowed": "string", "deepLinkAllowed": "string", "disconnectTimeoutInMinutes": number, "downloadAllowed": "string", "idleDisconnectTimeoutInMinutes": number, "pasteAllowed": "string", "printAllowed": "string", "toolbarConfiguration": { "hiddenToolbarItems": [ "string" ], "maxDisplayResolution": "string", "toolbarType": "string", "visualMode": "string" }, "uploadAllowed": "string", "userSettingsArn": "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. nextToken The pagination token used to retrieve the next page of results for this operation. Response Elements API Version 2020-07-08 207 Amazon WorkSpaces Secure Browser Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: ^\S+$ userSettings The user settings. Type: Array of UserSettingsSummary objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Access is denied. HTTP Status Code: 403 InternalServerException There is an internal server error. HTTP Status Code: 500 ThrottlingException There is a throttling error. HTTP Status Code: 429 ValidationException There is a validation error. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: Errors API Version 2020-07-08 208 API Reference Amazon WorkSpaces Secure Browser • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-07-08 209 Amazon WorkSpaces Secure Browser TagResource Adds or overwrites one or more tags for the specified resource. API Reference Request Syntax POST /tags/resourceArn+ HTTP/1.1 Content-type: application/json { "clientToken": "string", "tags": [ { "Key": "string", "Value": "string" } ] } URI Request Parameters The request uses the following URI parameters. resourceArn The ARN of the resource. Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ Required: Yes Request Body The request accepts the following data in JSON format. clientToken A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, TagResource API Version 2020-07-08 210 Amazon WorkSpaces Secure Browser API Reference if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request. If you do not specify a client token, one is automatically generated by the AWS SDK. Type: String Length Constraints: Minimum length of 1. Maximum length of 512. Required: No tags The tags of the resource. Type: Array of Tag objects Array Members: Minimum number of 0 items. Maximum number of 200 items. Required: Yes Response Syntax HTTP/1.1 200 Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Access is denied. HTTP Status Code: 403 InternalServerException There is an internal server error. Response Syntax API Version 2020-07-08 211 API Reference Amazon WorkSpaces Secure Browser HTTP Status Code: 500 ResourceNotFoundException The resource cannot be found. HTTP Status Code: 404 ThrottlingException There is a throttling error. HTTP Status Code: 429 TooManyTagsException There are too many tags. HTTP Status Code: 400 ValidationException There is a validation error. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-07-08 212 Amazon WorkSpaces Secure Browser API Reference See Also API Version 2020-07-08 213 API Reference Amazon WorkSpaces Secure Browser UntagResource Removes one or more tags from the specified resource. Request Syntax DELETE /tags/resourceArn+?tagKeys=tagKeys HTTP/1.1 URI Request Parameters The |
workspacesweb-api-035 | workspacesweb-api.pdf | 35 | the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-07-08 212 Amazon WorkSpaces Secure Browser API Reference See Also API Version 2020-07-08 213 API Reference Amazon WorkSpaces Secure Browser UntagResource Removes one or more tags from the specified resource. Request Syntax DELETE /tags/resourceArn+?tagKeys=tagKeys HTTP/1.1 URI Request Parameters The request uses the following URI parameters. resourceArn The ARN of the resource. Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ Required: Yes tagKeys The list of tag keys to remove from the resource. Array Members: Minimum number of 0 items. Maximum number of 200 items. Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$ Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 UntagResource API Version 2020-07-08 214 Amazon WorkSpaces Secure Browser Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Access is denied. HTTP Status Code: 403 InternalServerException There is an internal server error. HTTP Status Code: 500 ResourceNotFoundException The resource cannot be found. HTTP Status Code: 404 ThrottlingException There is a throttling error. HTTP Status Code: 429 ValidationException There is a validation error. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface Response Elements API Version 2020-07-08 215 API Reference Amazon WorkSpaces Secure Browser • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-07-08 216 Amazon WorkSpaces Secure Browser API Reference UpdateBrowserSettings Updates browser settings. Request Syntax PATCH /browserSettings/browserSettingsArn+ HTTP/1.1 Content-type: application/json { "browserPolicy": "string", "clientToken": "string" } URI Request Parameters The request uses the following URI parameters. browserSettingsArn The ARN of the browser settings. Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ Required: Yes Request Body The request accepts the following data in JSON format. browserPolicy A JSON string containing Chrome Enterprise policies that will be applied to all streaming sessions. Type: String Length Constraints: Minimum length of 2. Maximum length of 131072. UpdateBrowserSettings API Version 2020-07-08 217 Amazon WorkSpaces Secure Browser Pattern: \{[\S\s]*\}\s* Required: No clientToken API Reference A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token return the result from the original successful request. If you do not specify a client token, one is automatically generated by the AWS SDK. Type: String Length Constraints: Minimum length of 1. Maximum length of 512. Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "browserSettings": { "additionalEncryptionContext": { "string" : "string" }, "associatedPortalArns": [ "string" ], "browserPolicy": "string", "browserSettingsArn": "string", "customerManagedKey": "string" } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Response Syntax API Version 2020-07-08 218 Amazon WorkSpaces Secure Browser browserSettings The browser settings. Type: BrowserSettings object Errors For information about the errors that are common to all actions, see Common Errors. API Reference AccessDeniedException Access is denied. HTTP Status Code: 403 InternalServerException There is an internal server error. HTTP Status Code: 500 ResourceNotFoundException The resource cannot be found. HTTP Status Code: 404 ThrottlingException There is a throttling error. HTTP Status Code: 429 ValidationException There is a validation error. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: Errors API Version 2020-07-08 219 API Reference Amazon WorkSpaces Secure Browser • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-07-08 220 Amazon WorkSpaces Secure Browser API Reference UpdateDataProtectionSettings Updates data protection settings. Request Syntax PATCH /dataProtectionSettings/dataProtectionSettingsArn+ HTTP/1.1 Content-type: application/json { "clientToken": |
workspacesweb-api-036 | workspacesweb-api.pdf | 36 | of the language-specific AWS SDKs, see the following: Errors API Version 2020-07-08 219 API Reference Amazon WorkSpaces Secure Browser • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-07-08 220 Amazon WorkSpaces Secure Browser API Reference UpdateDataProtectionSettings Updates data protection settings. Request Syntax PATCH /dataProtectionSettings/dataProtectionSettingsArn+ HTTP/1.1 Content-type: application/json { "clientToken": "string", "description": "string", "displayName": "string", "inlineRedactionConfiguration": { "globalConfidenceLevel": number, "globalEnforcedUrls": [ "string" ], "globalExemptUrls": [ "string" ], "inlineRedactionPatterns": [ { "builtInPatternId": "string", "confidenceLevel": number, "customPattern": { "keywordRegex": "string", "patternDescription": "string", "patternName": "string", "patternRegex": "string" }, "enforcedUrls": [ "string" ], "exemptUrls": [ "string" ], "redactionPlaceHolder": { "redactionPlaceHolderText": "string", "redactionPlaceHolderType": "string" } } ] } } URI Request Parameters The request uses the following URI parameters. UpdateDataProtectionSettings API Version 2020-07-08 221 Amazon WorkSpaces Secure Browser dataProtectionSettingsArn The ARN of the data protection settings. API Reference Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ Required: Yes Request Body The request accepts the following data in JSON format. clientToken A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token return the result from the original successful request. If you do not specify a client token, one is automatically generated by the AWS SDK. Type: String Length Constraints: Minimum length of 1. Maximum length of 512. Required: No description The description of the data protection settings. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: ^[ _\-\d\w]+$ Required: No displayName The display name of the data protection settings. Request Body API Version 2020-07-08 222 Amazon WorkSpaces Secure Browser Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: ^[ _\-\d\w]+$ Required: No inlineRedactionConfiguration The inline redaction configuration of the data protection settings that will be applied to all sessions. Type: InlineRedactionConfiguration object Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "dataProtectionSettings": { "additionalEncryptionContext": { "string" : "string" }, "associatedPortalArns": [ "string" ], "creationDate": number, "customerManagedKey": "string", "dataProtectionSettingsArn": "string", "description": "string", "displayName": "string", "inlineRedactionConfiguration": { "globalConfidenceLevel": number, "globalEnforcedUrls": [ "string" ], "globalExemptUrls": [ "string" ], "inlineRedactionPatterns": [ { "builtInPatternId": "string", "confidenceLevel": number, "customPattern": { "keywordRegex": "string", Response Syntax API Version 2020-07-08 223 Amazon WorkSpaces Secure Browser API Reference "patternDescription": "string", "patternName": "string", "patternRegex": "string" }, "enforcedUrls": [ "string" ], "exemptUrls": [ "string" ], "redactionPlaceHolder": { "redactionPlaceHolderText": "string", "redactionPlaceHolderType": "string" } } ] } } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. dataProtectionSettings The data protection settings. Type: DataProtectionSettings object Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Access is denied. HTTP Status Code: 403 InternalServerException There is an internal server error. HTTP Status Code: 500 Response Elements API Version 2020-07-08 224 API Reference Amazon WorkSpaces Secure Browser ResourceNotFoundException The resource cannot be found. HTTP Status Code: 404 ThrottlingException There is a throttling error. HTTP Status Code: 429 ValidationException There is a validation error. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-07-08 225 Amazon WorkSpaces Secure Browser API Reference UpdateIdentityProvider Updates the identity provider. Request Syntax PATCH /identityProviders/identityProviderArn+ HTTP/1.1 Content-type: application/json { "clientToken": "string", "identityProviderDetails": { "string" : "string" }, "identityProviderName": "string", "identityProviderType": "string" } URI Request Parameters The request uses the following URI parameters. identityProviderArn The ARN of the identity provider. Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36}){2,}$ Required: Yes Request Body The request accepts the following data in JSON format. clientToken A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, UpdateIdentityProvider API Version 2020-07-08 226 Amazon WorkSpaces Secure Browser API Reference if the original request completes successfully, subsequent retries with the same client token return the result from the original successful request. If you do not specify a client token, one is automatically |
workspacesweb-api-037 | workspacesweb-api.pdf | 37 | the identity provider. Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36}){2,}$ Required: Yes Request Body The request accepts the following data in JSON format. clientToken A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, UpdateIdentityProvider API Version 2020-07-08 226 Amazon WorkSpaces Secure Browser API Reference if the original request completes successfully, subsequent retries with the same client token return the result from the original successful request. If you do not specify a client token, one is automatically generated by the AWS SDK. Type: String Length Constraints: Minimum length of 1. Maximum length of 512. Required: No identityProviderDetails The details of the identity provider. The following list describes the provider detail keys for each identity provider type. • For Google and Login with Amazon: • client_id • client_secret • authorize_scopes • For Facebook: • client_id • client_secret • authorize_scopes • api_version • For Sign in with Apple: • client_id • team_id • key_id • private_key • authorize_scopes • For OIDC providers: • client_id • client_secret • attributes_request_method • oidc_issuer Request Body API Version 2020-07-08 227 Amazon WorkSpaces Secure Browser • authorize_scopes API Reference • authorize_url if not available from discovery URL specified by oidc_issuer key • token_url if not available from discovery URL specified by oidc_issuer key • attributes_url if not available from discovery URL specified by oidc_issuer key • jwks_uri if not available from discovery URL specified by oidc_issuer key • For SAML providers: • MetadataFile OR MetadataURL • IDPSignout (boolean) optional • IDPInit (boolean) optional • RequestSigningAlgorithm (string) optional - Only accepts rsa-sha256 • EncryptedResponses (boolean) optional Type: String to string map Key Length Constraints: Minimum length of 0. Maximum length of 131072. Key Pattern: ^[\s\S]*$ Value Length Constraints: Minimum length of 0. Maximum length of 131072. Value Pattern: ^[\s\S]*$ Required: No identityProviderName The name of the identity provider. Type: String Length Constraints: Minimum length of 1. Maximum length of 32. Pattern: ^[^_][\p{L}\p{M}\p{S}\p{N}\p{P}][^_]+$ Required: No identityProviderType The type of the identity provider. Type: String Request Body API Version 2020-07-08 228 Amazon WorkSpaces Secure Browser API Reference Valid Values: SAML | Facebook | Google | LoginWithAmazon | SignInWithApple | OIDC Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "identityProvider": { "identityProviderArn": "string", "identityProviderDetails": { "string" : "string" }, "identityProviderName": "string", "identityProviderType": "string" } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. identityProvider The identity provider. Type: IdentityProvider object Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Access is denied. Response Syntax API Version 2020-07-08 229 API Reference Amazon WorkSpaces Secure Browser HTTP Status Code: 403 InternalServerException There is an internal server error. HTTP Status Code: 500 ResourceNotFoundException The resource cannot be found. HTTP Status Code: 404 ThrottlingException There is a throttling error. HTTP Status Code: 429 ValidationException There is a validation error. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-07-08 230 Amazon WorkSpaces Secure Browser API Reference See Also API Version 2020-07-08 231 Amazon WorkSpaces Secure Browser API Reference UpdateIpAccessSettings Updates IP access settings. Request Syntax PATCH /ipAccessSettings/ipAccessSettingsArn+ HTTP/1.1 Content-type: application/json { "clientToken": "string", "description": "string", "displayName": "string", "ipRules": [ { "description": "string", "ipRange": "string" } ] } URI Request Parameters The request uses the following URI parameters. ipAccessSettingsArn The ARN of the IP access settings. Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ Required: Yes Request Body The request accepts the following data in JSON format. UpdateIpAccessSettings API Version 2020-07-08 232 Amazon WorkSpaces Secure Browser clientToken API Reference A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token return the result from the original successful request. If you do not specify a client token, one is automatically generated by the AWS SDK. Type: String Length Constraints: Minimum length of 1. Maximum length of 512. Required: No description The description of the IP access settings. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: ^.+$ Required: No displayName The display name of the IP access |
workspacesweb-api-038 | workspacesweb-api.pdf | 38 | idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token return the result from the original successful request. If you do not specify a client token, one is automatically generated by the AWS SDK. Type: String Length Constraints: Minimum length of 1. Maximum length of 512. Required: No description The description of the IP access settings. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: ^.+$ Required: No displayName The display name of the IP access settings. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: ^.+$ Required: No ipRules The updated IP rules of the IP access settings. Type: Array of IpRule objects Array Members: Minimum number of 1 item. Maximum number of 100 items. Required: No Request Body API Version 2020-07-08 233 API Reference Amazon WorkSpaces Secure Browser Response Syntax HTTP/1.1 200 Content-type: application/json { "ipAccessSettings": { "additionalEncryptionContext": { "string" : "string" }, "associatedPortalArns": [ "string" ], "creationDate": number, "customerManagedKey": "string", "description": "string", "displayName": "string", "ipAccessSettingsArn": "string", "ipRules": [ { "description": "string", "ipRange": "string" } ] } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ipAccessSettings The IP access settings. Type: IpAccessSettings object Errors For information about the errors that are common to all actions, see Common Errors. Response Syntax API Version 2020-07-08 234 API Reference Amazon WorkSpaces Secure Browser AccessDeniedException Access is denied. HTTP Status Code: 403 InternalServerException There is an internal server error. HTTP Status Code: 500 ResourceNotFoundException The resource cannot be found. HTTP Status Code: 404 ThrottlingException There is a throttling error. HTTP Status Code: 429 ValidationException There is a validation error. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin See Also API Version 2020-07-08 235 Amazon WorkSpaces Secure Browser • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2020-07-08 236 Amazon WorkSpaces Secure Browser API Reference UpdateNetworkSettings Updates network settings. Request Syntax PATCH /networkSettings/networkSettingsArn+ HTTP/1.1 Content-type: application/json { "clientToken": "string", "securityGroupIds": [ "string" ], "subnetIds": [ "string" ], "vpcId": "string" } URI Request Parameters The request uses the following URI parameters. networkSettingsArn The ARN of the network settings. Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ Required: Yes Request Body The request accepts the following data in JSON format. clientToken A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token return the result from the original successful request. UpdateNetworkSettings API Version 2020-07-08 237 Amazon WorkSpaces Secure Browser API Reference If you do not specify a client token, one is automatically generated by the AWS SDK. Type: String Length Constraints: Minimum length of 1. Maximum length of 512. Required: No securityGroupIds One or more security groups used to control access from streaming instances to your VPC. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 5 items. Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: ^[\w+\-]+$ Required: No subnetIds The subnets in which network interfaces are created to connect streaming instances to your VPC. At least two of these subnets must be in different availability zones. Type: Array of strings Array Members: Minimum number of 2 items. Maximum number of 5 items. Length Constraints: Minimum length of 1. Maximum length of 32. Pattern: ^subnet-([0-9a-f]{8}|[0-9a-f]{17})$ Required: No vpcId The VPC that streaming instances will connect to. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Request Body API Version 2020-07-08 238 Amazon WorkSpaces Secure Browser API Reference Pattern: ^vpc-[0-9a-z]*$ Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "networkSettings": { "associatedPortalArns": [ "string" ], "networkSettingsArn": "string", "securityGroupIds": [ "string" ], "subnetIds": [ "string" ], "vpcId": "string" } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. networkSettings The network settings. Type: NetworkSettings object Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Access is denied. HTTP Status Code: 403 Response Syntax API Version 2020-07-08 239 API Reference Amazon WorkSpaces Secure Browser |
workspacesweb-api-039 | workspacesweb-api.pdf | 39 | Reference Pattern: ^vpc-[0-9a-z]*$ Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "networkSettings": { "associatedPortalArns": [ "string" ], "networkSettingsArn": "string", "securityGroupIds": [ "string" ], "subnetIds": [ "string" ], "vpcId": "string" } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. networkSettings The network settings. Type: NetworkSettings object Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Access is denied. HTTP Status Code: 403 Response Syntax API Version 2020-07-08 239 API Reference Amazon WorkSpaces Secure Browser InternalServerException There is an internal server error. HTTP Status Code: 500 ResourceNotFoundException The resource cannot be found. HTTP Status Code: 404 ThrottlingException There is a throttling error. HTTP Status Code: 429 ValidationException There is a validation error. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-07-08 240 API Reference Amazon WorkSpaces Secure Browser UpdatePortal Updates a web portal. Request Syntax PUT /portals/portalArn+ HTTP/1.1 Content-type: application/json { "authenticationType": "string", "displayName": "string", "instanceType": "string", "maxConcurrentSessions": number } URI Request Parameters The request uses the following URI parameters. portalArn The ARN of the web portal. Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ Required: Yes Request Body The request accepts the following data in JSON format. authenticationType The type of authentication integration points used when signing into the web portal. Defaults to Standard. UpdatePortal API Version 2020-07-08 241 Amazon WorkSpaces Secure Browser API Reference Standard web portals are authenticated directly through your identity provider. You need to call CreateIdentityProvider to integrate your identity provider with your web portal. User and group access to your web portal is controlled through your identity provider. IAM Identity Center web portals are authenticated through AWS IAM Identity Center. Identity sources (including external identity provider integration), plus user and group access to your web portal, can be configured in the IAM Identity Center. Type: String Valid Values: Standard | IAM_Identity_Center Required: No displayName The name of the web portal. This is not visible to users who log into the web portal. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: ^.+$ Required: No instanceType The type and resources of the underlying instance. Type: String Valid Values: standard.regular | standard.large | standard.xlarge Required: No maxConcurrentSessions The maximum number of concurrent sessions for the portal. Type: Integer Valid Range: Minimum value of 1. Maximum value of 5000. Required: No Request Body API Version 2020-07-08 242 API Reference Amazon WorkSpaces Secure Browser Response Syntax HTTP/1.1 200 Content-type: application/json { "portal": { "additionalEncryptionContext": { "string" : "string" }, "authenticationType": "string", "browserSettingsArn": "string", "browserType": "string", "creationDate": number, "customerManagedKey": "string", "dataProtectionSettingsArn": "string", "displayName": "string", "instanceType": "string", "ipAccessSettingsArn": "string", "maxConcurrentSessions": number, "networkSettingsArn": "string", "portalArn": "string", "portalEndpoint": "string", "portalStatus": "string", "rendererType": "string", "statusReason": "string", "trustStoreArn": "string", "userAccessLoggingSettingsArn": "string", "userSettingsArn": "string" } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. portal The web portal. Type: Portal object Response Syntax API Version 2020-07-08 243 Amazon WorkSpaces Secure Browser API Reference Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Access is denied. HTTP Status Code: 403 ConflictException There is a conflict. HTTP Status Code: 409 InternalServerException There is an internal server error. HTTP Status Code: 500 ResourceNotFoundException The resource cannot be found. HTTP Status Code: 404 ServiceQuotaExceededException The service quota has been exceeded. HTTP Status Code: 402 ThrottlingException There is a throttling error. HTTP Status Code: 429 ValidationException There is a validation error. HTTP Status Code: 400 Errors API Version 2020-07-08 244 Amazon WorkSpaces Secure Browser API Reference See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-07-08 245 API Reference Amazon WorkSpaces Secure Browser UpdateTrustStore Updates the trust store. Request Syntax PATCH /trustStores/trustStoreArn+ HTTP/1.1 Content-type: application/json { "certificatesToAdd": [ blob ], "certificatesToDelete": [ "string" ], "clientToken": "string" } URI |
workspacesweb-api-040 | workspacesweb-api.pdf | 40 | of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-07-08 245 API Reference Amazon WorkSpaces Secure Browser UpdateTrustStore Updates the trust store. Request Syntax PATCH /trustStores/trustStoreArn+ HTTP/1.1 Content-type: application/json { "certificatesToAdd": [ blob ], "certificatesToDelete": [ "string" ], "clientToken": "string" } URI Request Parameters The request uses the following URI parameters. trustStoreArn The ARN of the trust store. Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ Required: Yes Request Body The request accepts the following data in JSON format. certificatesToAdd A list of CA certificates to add to the trust store. Type: Array of Base64-encoded binary data objects Required: No UpdateTrustStore API Version 2020-07-08 246 API Reference Amazon WorkSpaces Secure Browser certificatesToDelete A list of CA certificates to delete from a trust store. Type: Array of strings Length Constraints: Fixed length of 64. Pattern: ^[A-Fa-f0-9]{64}$ Required: No clientToken A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token return the result from the original successful request. If you do not specify a client token, one is automatically generated by the AWS SDK. Type: String Length Constraints: Minimum length of 1. Maximum length of 512. Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "trustStoreArn": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Response Syntax API Version 2020-07-08 247 Amazon WorkSpaces Secure Browser trustStoreArn The ARN of the trust store. Type: String API Reference Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Access is denied. HTTP Status Code: 403 InternalServerException There is an internal server error. HTTP Status Code: 500 ResourceNotFoundException The resource cannot be found. HTTP Status Code: 404 ServiceQuotaExceededException The service quota has been exceeded. HTTP Status Code: 402 ThrottlingException There is a throttling error. HTTP Status Code: 429 Errors API Version 2020-07-08 248 Amazon WorkSpaces Secure Browser ValidationException There is a validation error. HTTP Status Code: 400 See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-07-08 249 Amazon WorkSpaces Secure Browser API Reference UpdateUserAccessLoggingSettings Updates the user access logging settings. Request Syntax PATCH /userAccessLoggingSettings/userAccessLoggingSettingsArn+ HTTP/1.1 Content-type: application/json { "clientToken": "string", "kinesisStreamArn": "string" } URI Request Parameters The request uses the following URI parameters. userAccessLoggingSettingsArn The ARN of the user access logging settings. Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ Required: Yes Request Body The request accepts the following data in JSON format. clientToken A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token return the result from the original successful request. If you do not specify a client token, one is automatically generated by the AWS SDK. UpdateUserAccessLoggingSettings API Version 2020-07-08 250 Amazon WorkSpaces Secure Browser Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 512. Required: No kinesisStreamArn The ARN of the Kinesis stream. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:[\w+=/,.@-]+:kinesis:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:stream/. + Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "userAccessLoggingSettings": { "associatedPortalArns": [ "string" ], "kinesisStreamArn": "string", "userAccessLoggingSettingsArn": "string" } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. userAccessLoggingSettings The user access logging settings. Type: UserAccessLoggingSettings object Response Syntax API Version 2020-07-08 251 Amazon WorkSpaces Secure Browser API Reference Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Access is denied. HTTP Status Code: 403 InternalServerException There is an internal server error. HTTP Status Code: 500 |
workspacesweb-api-041 | workspacesweb-api.pdf | 41 | Response Syntax HTTP/1.1 200 Content-type: application/json { "userAccessLoggingSettings": { "associatedPortalArns": [ "string" ], "kinesisStreamArn": "string", "userAccessLoggingSettingsArn": "string" } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. userAccessLoggingSettings The user access logging settings. Type: UserAccessLoggingSettings object Response Syntax API Version 2020-07-08 251 Amazon WorkSpaces Secure Browser API Reference Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Access is denied. HTTP Status Code: 403 InternalServerException There is an internal server error. HTTP Status Code: 500 ResourceNotFoundException The resource cannot be found. HTTP Status Code: 404 ThrottlingException There is a throttling error. HTTP Status Code: 429 ValidationException There is a validation error. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 Errors API Version 2020-07-08 252 Amazon WorkSpaces Secure Browser • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2020-07-08 253 Amazon WorkSpaces Secure Browser API Reference UpdateUserSettings Updates the user settings. Request Syntax PATCH /userSettings/userSettingsArn+ HTTP/1.1 Content-type: application/json { "clientToken": "string", "cookieSynchronizationConfiguration": { "allowlist": [ { "domain": "string", "name": "string", "path": "string" } ], "blocklist": [ { "domain": "string", "name": "string", "path": "string" } ] }, "copyAllowed": "string", "deepLinkAllowed": "string", "disconnectTimeoutInMinutes": number, "downloadAllowed": "string", "idleDisconnectTimeoutInMinutes": number, "pasteAllowed": "string", "printAllowed": "string", "toolbarConfiguration": { "hiddenToolbarItems": [ "string" ], "maxDisplayResolution": "string", "toolbarType": "string", "visualMode": "string" }, "uploadAllowed": "string" } UpdateUserSettings API Version 2020-07-08 254 Amazon WorkSpaces Secure Browser API Reference URI Request Parameters The request uses the following URI parameters. userSettingsArn The ARN of the user settings. Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ Required: Yes Request Body The request accepts the following data in JSON format. clientToken A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token return the result from the original successful request. If you do not specify a client token, one is automatically generated by the AWS SDK. Type: String Length Constraints: Minimum length of 1. Maximum length of 512. Required: No cookieSynchronizationConfiguration The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser. If the allowlist and blocklist are empty, the configuration becomes null. URI Request Parameters API Version 2020-07-08 255 Amazon WorkSpaces Secure Browser API Reference Type: CookieSynchronizationConfiguration object Required: No copyAllowed Specifies whether the user can copy text from the streaming session to the local device. Type: String Valid Values: Disabled | Enabled Required: No deepLinkAllowed Specifies whether the user can use deep links that open automatically when connecting to a session. Type: String Valid Values: Disabled | Enabled Required: No disconnectTimeoutInMinutes The amount of time that a streaming session remains active after users disconnect. Type: Integer Valid Range: Minimum value of 1. Maximum value of 600. Required: No downloadAllowed Specifies whether the user can download files from the streaming session to the local device. Type: String Valid Values: Disabled | Enabled Required: No Request Body API Version 2020-07-08 256 Amazon WorkSpaces Secure Browser API Reference idleDisconnectTimeoutInMinutes The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect timeout interval begins. Type: Integer Valid Range: Minimum value of 0. Maximum value of 60. Required: No pasteAllowed Specifies whether the user can paste text from the local device to the streaming session. Type: String Valid Values: Disabled | Enabled Required: No printAllowed Specifies whether the user can print to the local device. Type: String Valid Values: Disabled | Enabled Required: No toolbarConfiguration The configuration of the toolbar. This allows administrators to select the toolbar type and visual mode, set maximum display resolution for sessions, and choose which items are visible to end users during their sessions. If administrators do not modify these settings, end users retain control over their toolbar preferences. Type: ToolbarConfiguration object Required: No uploadAllowed Specifies whether the user can upload files from the local device to the streaming session. Request Body API Version 2020-07-08 257 API Reference Amazon WorkSpaces Secure Browser Type: String Valid Values: Disabled | Enabled Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "userSettings": { "additionalEncryptionContext": { "string" : "string" }, "associatedPortalArns": [ "string" ], "cookieSynchronizationConfiguration": { "allowlist": [ { "domain": "string", "name": "string", "path": |
workspacesweb-api-042 | workspacesweb-api.pdf | 42 | for sessions, and choose which items are visible to end users during their sessions. If administrators do not modify these settings, end users retain control over their toolbar preferences. Type: ToolbarConfiguration object Required: No uploadAllowed Specifies whether the user can upload files from the local device to the streaming session. Request Body API Version 2020-07-08 257 API Reference Amazon WorkSpaces Secure Browser Type: String Valid Values: Disabled | Enabled Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "userSettings": { "additionalEncryptionContext": { "string" : "string" }, "associatedPortalArns": [ "string" ], "cookieSynchronizationConfiguration": { "allowlist": [ { "domain": "string", "name": "string", "path": "string" } ], "blocklist": [ { "domain": "string", "name": "string", "path": "string" } ] }, "copyAllowed": "string", "customerManagedKey": "string", "deepLinkAllowed": "string", "disconnectTimeoutInMinutes": number, "downloadAllowed": "string", "idleDisconnectTimeoutInMinutes": number, "pasteAllowed": "string", "printAllowed": "string", "toolbarConfiguration": { "hiddenToolbarItems": [ "string" ], Response Syntax API Version 2020-07-08 258 Amazon WorkSpaces Secure Browser API Reference "maxDisplayResolution": "string", "toolbarType": "string", "visualMode": "string" }, "uploadAllowed": "string", "userSettingsArn": "string" } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. userSettings The user settings. Type: UserSettings object Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Access is denied. HTTP Status Code: 403 InternalServerException There is an internal server error. HTTP Status Code: 500 ResourceNotFoundException The resource cannot be found. HTTP Status Code: 404 Response Elements API Version 2020-07-08 259 API Reference Amazon WorkSpaces Secure Browser ThrottlingException There is a throttling error. HTTP Status Code: 429 ValidationException There is a validation error. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-07-08 260 Amazon WorkSpaces Secure Browser API Reference Data Types The Amazon WorkSpaces Web API contains several data types that various actions use. This section describes each data type in detail. Note The order of each element in a data type structure is not guaranteed. Applications should not assume a particular order. The following data types are supported: • BrowserSettings • BrowserSettingsSummary • Certificate • CertificateSummary • CookieSpecification • CookieSynchronizationConfiguration • CustomPattern • DataProtectionSettings • DataProtectionSettingsSummary • IdentityProvider • IdentityProviderSummary • InlineRedactionConfiguration • InlineRedactionPattern • IpAccessSettings • IpAccessSettingsSummary • IpRule • NetworkSettings • NetworkSettingsSummary • Portal • PortalSummary API Version 2020-07-08 261 Amazon WorkSpaces Secure Browser • RedactionPlaceHolder • Session • SessionSummary • Tag • ToolbarConfiguration • TrustStore • TrustStoreSummary • UserAccessLoggingSettings • UserAccessLoggingSettingsSummary • UserSettings • UserSettingsSummary • ValidationExceptionField API Reference API Version 2020-07-08 262 Amazon WorkSpaces Secure Browser BrowserSettings API Reference The browser settings resource that can be associated with a web portal. Once associated with a web portal, browser settings control how the browser will behave once a user starts a streaming session for the web portal. Contents browserSettingsArn The ARN of the browser settings. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ Required: Yes additionalEncryptionContext The additional encryption context of the browser settings. Type: String to string map Key Length Constraints: Minimum length of 0. Maximum length of 131072. Key Pattern: ^[\s\S]*$ Value Length Constraints: Minimum length of 0. Maximum length of 131072. Value Pattern: ^[\s\S]*$ Required: No associatedPortalArns A list of web portal ARNs that this browser settings is associated with. Type: Array of strings Length Constraints: Minimum length of 20. Maximum length of 2048. BrowserSettings API Version 2020-07-08 263 Amazon WorkSpaces Secure Browser API Reference Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ Required: No browserPolicy A JSON string containing Chrome Enterprise policies that will be applied to all streaming sessions. Type: String Length Constraints: Minimum length of 2. Maximum length of 131072. Pattern: \{[\S\s]*\}\s* Required: No customerManagedKey The customer managed key used to encrypt sensitive information in the browser settings. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:kms:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:key\/[a- zA-Z0-9-]+$ Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-07-08 264 Amazon WorkSpaces Secure Browser API Reference BrowserSettingsSummary The summary for browser settings. Contents browserSettingsArn The ARN of the browser settings. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ Required: Yes See Also For more information about using this API in one of the language-specific AWS SDKs, |
workspacesweb-api-043 | workspacesweb-api.pdf | 43 | Pattern: ^arn:[\w+=\/,.@-]+:kms:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:key\/[a- zA-Z0-9-]+$ Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-07-08 264 Amazon WorkSpaces Secure Browser API Reference BrowserSettingsSummary The summary for browser settings. Contents browserSettingsArn The ARN of the browser settings. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ Required: Yes See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 BrowserSettingsSummary API Version 2020-07-08 265 Amazon WorkSpaces Secure Browser API Reference Certificate The certificate. Contents body The body of the certificate. Type: Base64-encoded binary data object Required: No issuer The entity that issued the certificate. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: ^\S+$ Required: No notValidAfter The certificate is not valid after this date. Type: Timestamp Required: No notValidBefore The certificate is not valid before this date. Type: Timestamp Required: No subject The entity the certificate belongs to. Certificate API Version 2020-07-08 266 Amazon WorkSpaces Secure Browser Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: ^\S+$ Required: No thumbprint A hexadecimal identifier for the certificate. Type: String Length Constraints: Fixed length of 64. Pattern: ^[A-Fa-f0-9]{64}$ Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-07-08 267 Amazon WorkSpaces Secure Browser API Reference CertificateSummary The summary of the certificate. Contents issuer The entity that issued the certificate. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: ^\S+$ Required: No notValidAfter The certificate is not valid after this date. Type: Timestamp Required: No notValidBefore The certificate is not valid before this date. Type: Timestamp Required: No subject The entity the certificate belongs to. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: ^\S+$ Required: No CertificateSummary API Version 2020-07-08 268 API Reference Amazon WorkSpaces Secure Browser thumbprint A hexadecimal identifier for the certificate. Type: String Length Constraints: Fixed length of 64. Pattern: ^[A-Fa-f0-9]{64}$ Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-07-08 269 Amazon WorkSpaces Secure Browser CookieSpecification Specifies a single cookie or set of cookies in an end user's browser. API Reference Contents domain The domain of the cookie. Type: String Length Constraints: Minimum length of 0. Maximum length of 253. Pattern: ^(\.?)(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)*[a-z0-9][a-z0-9-] {0,61}[a-z0-9]$ Required: Yes name The name of the cookie. Type: String Length Constraints: Minimum length of 0. Maximum length of 4096. Required: No path The path of the cookie. Type: String Length Constraints: Minimum length of 0. Maximum length of 2000. Pattern: ^/(\S)*$ Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: CookieSpecification API Version 2020-07-08 270 Amazon WorkSpaces Secure Browser • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2020-07-08 271 Amazon WorkSpaces Secure Browser API Reference CookieSynchronizationConfiguration The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser. Contents allowlist The list of cookie specifications that are allowed to be synchronized to the remote browser. Type: Array of CookieSpecification objects Array Members: Minimum number of 0 items. Maximum number of 10 items. Required: Yes blocklist The list of cookie specifications that are blocked from being synchronized to the remote browser. Type: Array of CookieSpecification objects Array Members: Minimum number of 0 items. Maximum number of 10 items. Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 CookieSynchronizationConfiguration API Version 2020-07-08 272 Amazon WorkSpaces Secure Browser CustomPattern API Reference The pattern configuration for redacting custom data types in session. Contents patternName The pattern name for the custom pattern. Type: String Length Constraints: Minimum length of 1. Maximum length of 20. Pattern: ^[_\-\d\w]+$ Required: Yes patternRegex The pattern regex for the customer pattern. The format must follow JavaScript regex format. The pattern must be enclosed between slashes, and can have flags behind the second slash. For example: |
workspacesweb-api-044 | workspacesweb-api.pdf | 44 | SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 CookieSynchronizationConfiguration API Version 2020-07-08 272 Amazon WorkSpaces Secure Browser CustomPattern API Reference The pattern configuration for redacting custom data types in session. Contents patternName The pattern name for the custom pattern. Type: String Length Constraints: Minimum length of 1. Maximum length of 20. Pattern: ^[_\-\d\w]+$ Required: Yes patternRegex The pattern regex for the customer pattern. The format must follow JavaScript regex format. The pattern must be enclosed between slashes, and can have flags behind the second slash. For example: “/ab+c/gi”. Type: String Length Constraints: Minimum length of 0. Maximum length of 300. Pattern: ^\/((?:[^\n])+)\/([gimsuyvd]{0,8})$ Required: Yes keywordRegex The keyword regex for the customer pattern. After there is a match to the pattern regex, the keyword regex is used to search within the proximity of the match. If there is a keyword match, then the match is confirmed. If no keyword regex is provided, the pattern regex match will automatically be confirmed. The format must follow JavaScript regex format. The pattern must be enclosed between slashes, and can have flags behind the second slash. For example, “/ab+c/ gi” Type: String CustomPattern API Version 2020-07-08 273 Amazon WorkSpaces Secure Browser API Reference Length Constraints: Minimum length of 0. Maximum length of 300. Pattern: ^\/((?:[^\n])+)\/([gimsuyvd]{0,8})$ Required: No patternDescription The pattern description for the customer pattern. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: ^[ _\-\d\w]+$ Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-07-08 274 Amazon WorkSpaces Secure Browser API Reference DataProtectionSettings The data protection settings resource that can be associated with a web portal. Contents dataProtectionSettingsArn The ARN of the data protection settings resource. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ Required: Yes additionalEncryptionContext The additional encryption context of the data protection settings. Type: String to string map Key Length Constraints: Minimum length of 0. Maximum length of 131072. Key Pattern: ^[\s\S]*$ Value Length Constraints: Minimum length of 0. Maximum length of 131072. Value Pattern: ^[\s\S]*$ Required: No associatedPortalArns A list of web portal ARNs that this data protection settings resource is associated with. Type: Array of strings Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ DataProtectionSettings API Version 2020-07-08 275 Amazon WorkSpaces Secure Browser API Reference Required: No creationDate The creation date timestamp of the data protection settings. Type: Timestamp Required: No customerManagedKey The customer managed key used to encrypt sensitive information in the data protection settings. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:kms:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:key\/[a- zA-Z0-9-]+$ Required: No description The description of the data protection settings. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: ^[ _\-\d\w]+$ Required: No displayName The display name of the data protection settings. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: ^[ _\-\d\w]+$ Contents API Version 2020-07-08 276 Amazon WorkSpaces Secure Browser Required: No inlineRedactionConfiguration The inline redaction configuration for the data protection settings. Type: InlineRedactionConfiguration object API Reference Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-07-08 277 Amazon WorkSpaces Secure Browser API Reference DataProtectionSettingsSummary The summary of the data protection settings. Contents dataProtectionSettingsArn The ARN of the data protection settings. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ Required: Yes creationDate The creation date timestamp of the data protection settings. Type: Timestamp Required: No description The description of the data protection settings. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: ^[ _\-\d\w]+$ Required: No displayName The display name of the data protection settings. Type: String DataProtectionSettingsSummary API Version 2020-07-08 278 Amazon WorkSpaces Secure Browser API Reference Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: ^[ _\-\d\w]+$ Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-07-08 279 API Reference Amazon WorkSpaces Secure Browser IdentityProvider The identity provider. Contents identityProviderArn The ARN of the identity provider. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36}){2,}$ Required: Yes identityProviderDetails The identity provider details. The following list describes the provider detail |
workspacesweb-api-045 | workspacesweb-api.pdf | 45 | of 1. Maximum length of 64. Pattern: ^[ _\-\d\w]+$ Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-07-08 279 API Reference Amazon WorkSpaces Secure Browser IdentityProvider The identity provider. Contents identityProviderArn The ARN of the identity provider. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36}){2,}$ Required: Yes identityProviderDetails The identity provider details. The following list describes the provider detail keys for each identity provider type. • For Google and Login with Amazon: • client_id • client_secret • authorize_scopes • For Facebook: • client_id • client_secret • authorize_scopes • api_version • For Sign in with Apple: • client_id • team_id • key_id • private_key IdentityProvider API Version 2020-07-08 280 Amazon WorkSpaces Secure Browser • authorize_scopes • For OIDC providers: • client_id • client_secret • attributes_request_method • oidc_issuer • authorize_scopes API Reference • authorize_url if not available from discovery URL specified by oidc_issuer key • token_url if not available from discovery URL specified by oidc_issuer key • attributes_url if not available from discovery URL specified by oidc_issuer key • jwks_uri if not available from discovery URL specified by oidc_issuer key • For SAML providers: • MetadataFile OR MetadataURL • IDPSignout (boolean) optional • IDPInit (boolean) optional • RequestSigningAlgorithm (string) optional - Only accepts rsa-sha256 • EncryptedResponses (boolean) optional Type: String to string map Key Length Constraints: Minimum length of 0. Maximum length of 131072. Key Pattern: ^[\s\S]*$ Value Length Constraints: Minimum length of 0. Maximum length of 131072. Value Pattern: ^[\s\S]*$ Required: No identityProviderName The identity provider name. Type: String Length Constraints: Minimum length of 1. Maximum length of 32. Contents API Version 2020-07-08 281 Amazon WorkSpaces Secure Browser API Reference Pattern: ^[^_][\p{L}\p{M}\p{S}\p{N}\p{P}][^_]+$ Required: No identityProviderType The identity provider type. Type: String Valid Values: SAML | Facebook | Google | LoginWithAmazon | SignInWithApple | OIDC Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-07-08 282 Amazon WorkSpaces Secure Browser API Reference IdentityProviderSummary The summary of the identity provider. Contents identityProviderArn The ARN of the identity provider. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36}){2,}$ Required: Yes identityProviderName The identity provider name. Type: String Length Constraints: Minimum length of 1. Maximum length of 32. Pattern: ^[^_][\p{L}\p{M}\p{S}\p{N}\p{P}][^_]+$ Required: No identityProviderType The identity provider type. Type: String Valid Values: SAML | Facebook | Google | LoginWithAmazon | SignInWithApple | OIDC Required: No IdentityProviderSummary API Version 2020-07-08 283 Amazon WorkSpaces Secure Browser API Reference See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-07-08 284 Amazon WorkSpaces Secure Browser API Reference InlineRedactionConfiguration The configuration for in-session inline redaction. Contents inlineRedactionPatterns The inline redaction patterns to be enabled for the inline redaction configuration. Type: Array of InlineRedactionPattern objects Array Members: Minimum number of 0 items. Maximum number of 150 items. Required: Yes globalConfidenceLevel The global confidence level for the inline redaction configuration. This indicates the certainty of data type matches in the redaction process. Confidence level 3 means high confidence, and requires a formatted text pattern match in order for content to be redacted. Confidence level 2 means medium confidence, and redaction considers both formatted and unformatted text, and adds keyword associate to the logic. Confidence level 1 means low confidence, and redaction is enforced for both formatted pattern + unformatted pattern without keyword. This is applied to patterns that do not have a pattern-level confidence level. Defaults to confidence level 2. Type: Integer Valid Range: Minimum value of 1. Maximum value of 3. Required: No globalEnforcedUrls The global enforced URL configuration for the inline redaction configuration. This is applied to patterns that do not have a pattern-level enforced URL list. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 100 items. Pattern: ^((([a-zA-Z][a-zA-Z0-9+.-]*):\/\/(\*|[\w%._\-\+~#=@]+)?(\/[^@ \s]*)?(?:\?([^*\s]+(?:\*?)))?)|(\*|[\w%._\-\+~#=@]+\.[\w%._\-\+~#=@]+) InlineRedactionConfiguration API Version 2020-07-08 285 Amazon WorkSpaces Secure Browser API Reference (?::(\d{1,5}))?(\/[^@\s]*)?(?:\?([^*\s]+(?:\*?)))?|(([a-zA-Z][a-zA- Z0-9+.-]*):(\/\/)?\*))$ Required: No globalExemptUrls The global exempt URL configuration for the inline redaction configuration. This is applied to patterns that do not have a pattern-level exempt URL list. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 100 items. Pattern: ^((([a-zA-Z][a-zA-Z0-9+.-]*):\/\/(\*|[\w%._\-\+~#=@]+)?(\/[^@ \s]*)?(?:\?([^*\s]+(?:\*?)))?)|(\*|[\w%._\-\+~#=@]+\.[\w%._\-\+~#=@]+) (?::(\d{1,5}))?(\/[^@\s]*)?(?:\?([^*\s]+(?:\*?)))?|(([a-zA-Z][a-zA- Z0-9+.-]*):(\/\/)?\*))$ Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.