2025/02/20 - Amazon WorkSpaces Web - 4 updated api methods
Changes Add support for toolbar configuration under user settings.
{'toolbarConfiguration': {'hiddenToolbarItems': ['Windows | DualMonitor | '
'FullScreen | Webcam | '
'Microphone'],
'maxDisplayResolution': 'size4096X2160 | '
'size3840X2160 | '
'size3440X1440 | '
'size2560X1440 | '
'size1920X1080 | '
'size1280X720 | size1024X768 '
'| size800X600',
'toolbarType': 'Floating | Docked',
'visualMode': 'Dark | Light'}}
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.
See also: AWS API Documentation
Request Syntax
client.create_user_settings(
additionalEncryptionContext={
'string': 'string'
},
clientToken='string',
cookieSynchronizationConfiguration={
'allowlist': [
{
'domain': 'string',
'name': 'string',
'path': 'string'
},
],
'blocklist': [
{
'domain': 'string',
'name': 'string',
'path': 'string'
},
]
},
copyAllowed='Disabled'|'Enabled',
customerManagedKey='string',
deepLinkAllowed='Disabled'|'Enabled',
disconnectTimeoutInMinutes=123,
downloadAllowed='Disabled'|'Enabled',
idleDisconnectTimeoutInMinutes=123,
pasteAllowed='Disabled'|'Enabled',
printAllowed='Disabled'|'Enabled',
tags=[
{
'Key': 'string',
'Value': 'string'
},
],
toolbarConfiguration={
'hiddenToolbarItems': [
'Windows'|'DualMonitor'|'FullScreen'|'Webcam'|'Microphone',
],
'maxDisplayResolution': 'size4096X2160'|'size3840X2160'|'size3440X1440'|'size2560X1440'|'size1920X1080'|'size1280X720'|'size1024X768'|'size800X600',
'toolbarType': 'Floating'|'Docked',
'visualMode': 'Dark'|'Light'
},
uploadAllowed='Disabled'|'Enabled'
)
dict
The additional encryption context of the user settings.
(string) --
(string) --
string
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 Amazon Web Services SDK.
This field is autopopulated if not provided.
dict
The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser.
allowlist (list) -- [REQUIRED]
The list of cookie specifications that are allowed to be synchronized to the remote browser.
(dict) --
Specifies a single cookie or set of cookies in an end user's browser.
domain (string) -- [REQUIRED]
The domain of the cookie.
name (string) --
The name of the cookie.
path (string) --
The path of the cookie.
blocklist (list) --
The list of cookie specifications that are blocked from being synchronized to the remote browser.
(dict) --
Specifies a single cookie or set of cookies in an end user's browser.
domain (string) -- [REQUIRED]
The domain of the cookie.
name (string) --
The name of the cookie.
path (string) --
The path of the cookie.
string
[REQUIRED]
Specifies whether the user can copy text from the streaming session to the local device.
string
The customer managed key used to encrypt sensitive information in the user settings.
string
Specifies whether the user can use deep links that open automatically when connecting to a session.
integer
The amount of time that a streaming session remains active after users disconnect.
string
[REQUIRED]
Specifies whether the user can download files from the streaming session to the local device.
integer
The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect timeout interval begins.
string
[REQUIRED]
Specifies whether the user can paste text from the local device to the streaming session.
string
[REQUIRED]
Specifies whether the user can print to the local device.
list
The tags to add to the user settings resource. A tag is a key-value pair.
(dict) --
The tag.
Key (string) -- [REQUIRED]
The key of the tag.
Value (string) -- [REQUIRED]
The value of the tag
dict
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.
hiddenToolbarItems (list) --
The list of toolbar items to be hidden.
(string) --
maxDisplayResolution (string) --
The maximum display resolution that is allowed for the session.
toolbarType (string) --
The type of toolbar displayed during the session.
visualMode (string) --
The visual mode of the toolbar.
string
[REQUIRED]
Specifies whether the user can upload files from the local device to the streaming session.
dict
Response Syntax
{
'userSettingsArn': 'string'
}
Response Structure
(dict) --
userSettingsArn (string) --
The ARN of the user settings.
{'userSettings': {'toolbarConfiguration': {'hiddenToolbarItems': ['Windows | '
'DualMonitor '
'| '
'FullScreen '
'| Webcam | '
'Microphone'],
'maxDisplayResolution': 'size4096X2160 '
'| '
'size3840X2160 '
'| '
'size3440X1440 '
'| '
'size2560X1440 '
'| '
'size1920X1080 '
'| '
'size1280X720 '
'| '
'size1024X768 '
'| '
'size800X600',
'toolbarType': 'Floating | Docked',
'visualMode': 'Dark | Light'}}}
Gets user settings.
See also: AWS API Documentation
Request Syntax
client.get_user_settings(
userSettingsArn='string'
)
string
[REQUIRED]
The ARN of the user settings.
dict
Response Syntax
{
'userSettings': {
'additionalEncryptionContext': {
'string': 'string'
},
'associatedPortalArns': [
'string',
],
'cookieSynchronizationConfiguration': {
'allowlist': [
{
'domain': 'string',
'name': 'string',
'path': 'string'
},
],
'blocklist': [
{
'domain': 'string',
'name': 'string',
'path': 'string'
},
]
},
'copyAllowed': 'Disabled'|'Enabled',
'customerManagedKey': 'string',
'deepLinkAllowed': 'Disabled'|'Enabled',
'disconnectTimeoutInMinutes': 123,
'downloadAllowed': 'Disabled'|'Enabled',
'idleDisconnectTimeoutInMinutes': 123,
'pasteAllowed': 'Disabled'|'Enabled',
'printAllowed': 'Disabled'|'Enabled',
'toolbarConfiguration': {
'hiddenToolbarItems': [
'Windows'|'DualMonitor'|'FullScreen'|'Webcam'|'Microphone',
],
'maxDisplayResolution': 'size4096X2160'|'size3840X2160'|'size3440X1440'|'size2560X1440'|'size1920X1080'|'size1280X720'|'size1024X768'|'size800X600',
'toolbarType': 'Floating'|'Docked',
'visualMode': 'Dark'|'Light'
},
'uploadAllowed': 'Disabled'|'Enabled',
'userSettingsArn': 'string'
}
}
Response Structure
(dict) --
userSettings (dict) --
The user settings.
additionalEncryptionContext (dict) --
The additional encryption context of the user settings.
(string) --
(string) --
associatedPortalArns (list) --
A list of web portal ARNs that this user settings is associated with.
(string) --
cookieSynchronizationConfiguration (dict) --
The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser.
allowlist (list) --
The list of cookie specifications that are allowed to be synchronized to the remote browser.
(dict) --
Specifies a single cookie or set of cookies in an end user's browser.
domain (string) --
The domain of the cookie.
name (string) --
The name of the cookie.
path (string) --
The path of the cookie.
blocklist (list) --
The list of cookie specifications that are blocked from being synchronized to the remote browser.
(dict) --
Specifies a single cookie or set of cookies in an end user's browser.
domain (string) --
The domain of the cookie.
name (string) --
The name of the cookie.
path (string) --
The path of the cookie.
copyAllowed (string) --
Specifies whether the user can copy text from the streaming session to the local device.
customerManagedKey (string) --
The customer managed key used to encrypt sensitive information in the user settings.
deepLinkAllowed (string) --
Specifies whether the user can use deep links that open automatically when connecting to a session.
disconnectTimeoutInMinutes (integer) --
The amount of time that a streaming session remains active after users disconnect.
downloadAllowed (string) --
Specifies whether the user can download files from the streaming session to the local device.
idleDisconnectTimeoutInMinutes (integer) --
The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect timeout interval begins.
pasteAllowed (string) --
Specifies whether the user can paste text from the local device to the streaming session.
printAllowed (string) --
Specifies whether the user can print to the local device.
toolbarConfiguration (dict) --
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.
hiddenToolbarItems (list) --
The list of toolbar items to be hidden.
(string) --
maxDisplayResolution (string) --
The maximum display resolution that is allowed for the session.
toolbarType (string) --
The type of toolbar displayed during the session.
visualMode (string) --
The visual mode of the toolbar.
uploadAllowed (string) --
Specifies whether the user can upload files from the local device to the streaming session.
userSettingsArn (string) --
The ARN of the user settings.
{'userSettings': {'toolbarConfiguration': {'hiddenToolbarItems': ['Windows | '
'DualMonitor '
'| '
'FullScreen '
'| Webcam | '
'Microphone'],
'maxDisplayResolution': 'size4096X2160 '
'| '
'size3840X2160 '
'| '
'size3440X1440 '
'| '
'size2560X1440 '
'| '
'size1920X1080 '
'| '
'size1280X720 '
'| '
'size1024X768 '
'| '
'size800X600',
'toolbarType': 'Floating | Docked',
'visualMode': 'Dark | Light'}}}
Retrieves a list of user settings.
See also: AWS API Documentation
Request Syntax
client.list_user_settings(
maxResults=123,
nextToken='string'
)
integer
The maximum number of results to be included in the next page.
string
The pagination token used to retrieve the next page of results for this operation.
dict
Response Syntax
{
'nextToken': 'string',
'userSettings': [
{
'cookieSynchronizationConfiguration': {
'allowlist': [
{
'domain': 'string',
'name': 'string',
'path': 'string'
},
],
'blocklist': [
{
'domain': 'string',
'name': 'string',
'path': 'string'
},
]
},
'copyAllowed': 'Disabled'|'Enabled',
'deepLinkAllowed': 'Disabled'|'Enabled',
'disconnectTimeoutInMinutes': 123,
'downloadAllowed': 'Disabled'|'Enabled',
'idleDisconnectTimeoutInMinutes': 123,
'pasteAllowed': 'Disabled'|'Enabled',
'printAllowed': 'Disabled'|'Enabled',
'toolbarConfiguration': {
'hiddenToolbarItems': [
'Windows'|'DualMonitor'|'FullScreen'|'Webcam'|'Microphone',
],
'maxDisplayResolution': 'size4096X2160'|'size3840X2160'|'size3440X1440'|'size2560X1440'|'size1920X1080'|'size1280X720'|'size1024X768'|'size800X600',
'toolbarType': 'Floating'|'Docked',
'visualMode': 'Dark'|'Light'
},
'uploadAllowed': 'Disabled'|'Enabled',
'userSettingsArn': 'string'
},
]
}
Response Structure
(dict) --
nextToken (string) --
The pagination token used to retrieve the next page of results for this operation.
userSettings (list) --
The user settings.
(dict) --
The summary of user settings.
cookieSynchronizationConfiguration (dict) --
The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser.
allowlist (list) --
The list of cookie specifications that are allowed to be synchronized to the remote browser.
(dict) --
Specifies a single cookie or set of cookies in an end user's browser.
domain (string) --
The domain of the cookie.
name (string) --
The name of the cookie.
path (string) --
The path of the cookie.
blocklist (list) --
The list of cookie specifications that are blocked from being synchronized to the remote browser.
(dict) --
Specifies a single cookie or set of cookies in an end user's browser.
domain (string) --
The domain of the cookie.
name (string) --
The name of the cookie.
path (string) --
The path of the cookie.
copyAllowed (string) --
Specifies whether the user can copy text from the streaming session to the local device.
deepLinkAllowed (string) --
Specifies whether the user can use deep links that open automatically when connecting to a session.
disconnectTimeoutInMinutes (integer) --
The amount of time that a streaming session remains active after users disconnect.
downloadAllowed (string) --
Specifies whether the user can download files from the streaming session to the local device.
idleDisconnectTimeoutInMinutes (integer) --
The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect timeout interval begins.
pasteAllowed (string) --
Specifies whether the user can paste text from the local device to the streaming session.
printAllowed (string) --
Specifies whether the user can print to the local device.
toolbarConfiguration (dict) --
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.
hiddenToolbarItems (list) --
The list of toolbar items to be hidden.
(string) --
maxDisplayResolution (string) --
The maximum display resolution that is allowed for the session.
toolbarType (string) --
The type of toolbar displayed during the session.
visualMode (string) --
The visual mode of the toolbar.
uploadAllowed (string) --
Specifies whether the user can upload files from the local device to the streaming session.
userSettingsArn (string) --
The ARN of the user settings.
{'toolbarConfiguration': {'hiddenToolbarItems': ['Windows | DualMonitor | '
'FullScreen | Webcam | '
'Microphone'],
'maxDisplayResolution': 'size4096X2160 | '
'size3840X2160 | '
'size3440X1440 | '
'size2560X1440 | '
'size1920X1080 | '
'size1280X720 | size1024X768 '
'| size800X600',
'toolbarType': 'Floating | Docked',
'visualMode': 'Dark | Light'}}
Response {'userSettings': {'toolbarConfiguration': {'hiddenToolbarItems': ['Windows | '
'DualMonitor '
'| '
'FullScreen '
'| Webcam | '
'Microphone'],
'maxDisplayResolution': 'size4096X2160 '
'| '
'size3840X2160 '
'| '
'size3440X1440 '
'| '
'size2560X1440 '
'| '
'size1920X1080 '
'| '
'size1280X720 '
'| '
'size1024X768 '
'| '
'size800X600',
'toolbarType': 'Floating | Docked',
'visualMode': 'Dark | Light'}}}
Updates the user settings.
See also: AWS API Documentation
Request Syntax
client.update_user_settings(
clientToken='string',
cookieSynchronizationConfiguration={
'allowlist': [
{
'domain': 'string',
'name': 'string',
'path': 'string'
},
],
'blocklist': [
{
'domain': 'string',
'name': 'string',
'path': 'string'
},
]
},
copyAllowed='Disabled'|'Enabled',
deepLinkAllowed='Disabled'|'Enabled',
disconnectTimeoutInMinutes=123,
downloadAllowed='Disabled'|'Enabled',
idleDisconnectTimeoutInMinutes=123,
pasteAllowed='Disabled'|'Enabled',
printAllowed='Disabled'|'Enabled',
toolbarConfiguration={
'hiddenToolbarItems': [
'Windows'|'DualMonitor'|'FullScreen'|'Webcam'|'Microphone',
],
'maxDisplayResolution': 'size4096X2160'|'size3840X2160'|'size3440X1440'|'size2560X1440'|'size1920X1080'|'size1280X720'|'size1024X768'|'size800X600',
'toolbarType': 'Floating'|'Docked',
'visualMode': 'Dark'|'Light'
},
uploadAllowed='Disabled'|'Enabled',
userSettingsArn='string'
)
string
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 Amazon Web Services SDK.
This field is autopopulated if not provided.
dict
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.
allowlist (list) -- [REQUIRED]
The list of cookie specifications that are allowed to be synchronized to the remote browser.
(dict) --
Specifies a single cookie or set of cookies in an end user's browser.
domain (string) -- [REQUIRED]
The domain of the cookie.
name (string) --
The name of the cookie.
path (string) --
The path of the cookie.
blocklist (list) --
The list of cookie specifications that are blocked from being synchronized to the remote browser.
(dict) --
Specifies a single cookie or set of cookies in an end user's browser.
domain (string) -- [REQUIRED]
The domain of the cookie.
name (string) --
The name of the cookie.
path (string) --
The path of the cookie.
string
Specifies whether the user can copy text from the streaming session to the local device.
string
Specifies whether the user can use deep links that open automatically when connecting to a session.
integer
The amount of time that a streaming session remains active after users disconnect.
string
Specifies whether the user can download files from the streaming session to the local device.
integer
The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect timeout interval begins.
string
Specifies whether the user can paste text from the local device to the streaming session.
string
Specifies whether the user can print to the local device.
dict
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.
hiddenToolbarItems (list) --
The list of toolbar items to be hidden.
(string) --
maxDisplayResolution (string) --
The maximum display resolution that is allowed for the session.
toolbarType (string) --
The type of toolbar displayed during the session.
visualMode (string) --
The visual mode of the toolbar.
string
Specifies whether the user can upload files from the local device to the streaming session.
string
[REQUIRED]
The ARN of the user settings.
dict
Response Syntax
{
'userSettings': {
'additionalEncryptionContext': {
'string': 'string'
},
'associatedPortalArns': [
'string',
],
'cookieSynchronizationConfiguration': {
'allowlist': [
{
'domain': 'string',
'name': 'string',
'path': 'string'
},
],
'blocklist': [
{
'domain': 'string',
'name': 'string',
'path': 'string'
},
]
},
'copyAllowed': 'Disabled'|'Enabled',
'customerManagedKey': 'string',
'deepLinkAllowed': 'Disabled'|'Enabled',
'disconnectTimeoutInMinutes': 123,
'downloadAllowed': 'Disabled'|'Enabled',
'idleDisconnectTimeoutInMinutes': 123,
'pasteAllowed': 'Disabled'|'Enabled',
'printAllowed': 'Disabled'|'Enabled',
'toolbarConfiguration': {
'hiddenToolbarItems': [
'Windows'|'DualMonitor'|'FullScreen'|'Webcam'|'Microphone',
],
'maxDisplayResolution': 'size4096X2160'|'size3840X2160'|'size3440X1440'|'size2560X1440'|'size1920X1080'|'size1280X720'|'size1024X768'|'size800X600',
'toolbarType': 'Floating'|'Docked',
'visualMode': 'Dark'|'Light'
},
'uploadAllowed': 'Disabled'|'Enabled',
'userSettingsArn': 'string'
}
}
Response Structure
(dict) --
userSettings (dict) --
The user settings.
additionalEncryptionContext (dict) --
The additional encryption context of the user settings.
(string) --
(string) --
associatedPortalArns (list) --
A list of web portal ARNs that this user settings is associated with.
(string) --
cookieSynchronizationConfiguration (dict) --
The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser.
allowlist (list) --
The list of cookie specifications that are allowed to be synchronized to the remote browser.
(dict) --
Specifies a single cookie or set of cookies in an end user's browser.
domain (string) --
The domain of the cookie.
name (string) --
The name of the cookie.
path (string) --
The path of the cookie.
blocklist (list) --
The list of cookie specifications that are blocked from being synchronized to the remote browser.
(dict) --
Specifies a single cookie or set of cookies in an end user's browser.
domain (string) --
The domain of the cookie.
name (string) --
The name of the cookie.
path (string) --
The path of the cookie.
copyAllowed (string) --
Specifies whether the user can copy text from the streaming session to the local device.
customerManagedKey (string) --
The customer managed key used to encrypt sensitive information in the user settings.
deepLinkAllowed (string) --
Specifies whether the user can use deep links that open automatically when connecting to a session.
disconnectTimeoutInMinutes (integer) --
The amount of time that a streaming session remains active after users disconnect.
downloadAllowed (string) --
Specifies whether the user can download files from the streaming session to the local device.
idleDisconnectTimeoutInMinutes (integer) --
The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect timeout interval begins.
pasteAllowed (string) --
Specifies whether the user can paste text from the local device to the streaming session.
printAllowed (string) --
Specifies whether the user can print to the local device.
toolbarConfiguration (dict) --
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.
hiddenToolbarItems (list) --
The list of toolbar items to be hidden.
(string) --
maxDisplayResolution (string) --
The maximum display resolution that is allowed for the session.
toolbarType (string) --
The type of toolbar displayed during the session.
visualMode (string) --
The visual mode of the toolbar.
uploadAllowed (string) --
Specifies whether the user can upload files from the local device to the streaming session.
userSettingsArn (string) --
The ARN of the user settings.