View a markdown version of this page

UserSetting - Amazon WorkSpaces Applications

UserSetting

Describes an action and whether the action is enabled or disabled for users during their streaming sessions.

Contents

Action

The action you want to enable or disable. Choose from the following:

AUTO_TIME_ZONE_REDIRECTION

Controls whether the streaming session's time zone matches the time zone of your local device.

CLIPBOARD_COPY_FROM_LOCAL_DEVICE

Controls whether you can copy data from your local device and paste it into the streaming session.

CLIPBOARD_COPY_TO_LOCAL_DEVICE

Controls whether you can copy data from the streaming session and paste it to your local device.

DOMAIN_PASSWORD_SIGNIN

Controls whether you can sign in to a domain-joined streaming session by using your password.

DOMAIN_SMART_CARD_SIGNIN

Controls whether you can sign in to a domain-joined streaming session by using a smart card.

FILE_DOWNLOAD

Controls whether you can download files from the streaming session to your local device.

FILE_UPLOAD

Controls whether you can upload files from your local device to the streaming session.

PRINTING_TO_LOCAL_DEVICE

Controls whether you can print from the streaming session to a printer on your local device.

SMART_CARD_REDIRECTION

Controls whether smart cards connected to your local device are redirected into the streaming session. Applications in the session can access the local smart card for use cases such as authentication, digital signing, and email encryption.

Note

Smart card redirection was on by default for existing streaming sessions that use a Windows single-session fleet. To preserve that behavior, SMART_CARD_REDIRECTION is ENABLED by default on existing stacks associated with Windows single-session fleets. To turn it off, call UpdateStack with SMART_CARD_REDIRECTION set to DISABLED, and use an image that includes the latest WorkSpaces Applications agent version.

Type: String

Valid Values: CLIPBOARD_COPY_FROM_LOCAL_DEVICE | CLIPBOARD_COPY_TO_LOCAL_DEVICE | FILE_UPLOAD | FILE_DOWNLOAD | PRINTING_TO_LOCAL_DEVICE | DOMAIN_PASSWORD_SIGNIN | DOMAIN_SMART_CARD_SIGNIN | AUTO_TIME_ZONE_REDIRECTION | SMART_CARD_REDIRECTION

Required: Yes

Permission

Specifies whether to turn the action on or off.

Type: String

Valid Values: ENABLED | DISABLED

Required: Yes

MaximumLength

Specifies the number of characters that can be copied by end users from the local device to the remote session, and to the local device from the remote session.

This can be specified only for the CLIPBOARD_COPY_FROM_LOCAL_DEVICE and CLIPBOARD_COPY_TO_LOCAL_DEVICE actions.

This defaults to 20,971,520 (20 MB) when unspecified and the permission is ENABLED. This can't be specified when the permission is DISABLED.

The value can be between 1 and 20,971,520 (20 MB).

Type: Integer

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: