Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1475327289.3 KB

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.

post/userSettings

Request body

copyAllowed'Disabled' | 'Enabled' required

Specifies whether the user can copy text from the streaming session to the local device.

pasteAllowed'Disabled' | 'Enabled' required

Specifies whether the user can paste text from the local device to the streaming session.

downloadAllowed'Disabled' | 'Enabled' required

Specifies whether the user can download files from the streaming session to the local device.

uploadAllowed'Disabled' | 'Enabled' required

Specifies whether the user can upload files from the local device to the streaming session.

printAllowed'Disabled' | 'Enabled' required

Specifies whether the user can print to the local device.

disconnectTimeoutInMinutesinteger

The amount of time that a streaming session remains active after users disconnect.

idleDisconnectTimeoutInMinutesinteger

The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect timeout interval begins.

clientTokenstring
<p>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. </p> <p>If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.</p>
customerManagedKeystring

The customer managed key used to encrypt sensitive information in the user settings.

additionalEncryptionContextobject

The additional encryption context of the user settings.

deepLinkAllowed'Disabled' | 'Enabled'

Specifies whether the user can use deep links that open automatically when connecting to a session.

webAuthnAllowed'Disabled' | 'Enabled'

Specifies whether the user can use WebAuthn redirection for passwordless login to websites within the streaming session.

Response

Success

userSettingsArnstring required

The ARN of the user settings.