Update User Settings

workspacesweb_update_user_settings

R Documentation

Updates the user settings

Description

Updates the user settings.

Usage

workspacesweb_update_user_settings(clientToken,
  cookieSynchronizationConfiguration, copyAllowed, deepLinkAllowed,
  disconnectTimeoutInMinutes, downloadAllowed,
  idleDisconnectTimeoutInMinutes, pasteAllowed, printAllowed,
  uploadAllowed, userSettingsArn)

Arguments

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 Amazon Web Services SDK.

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.

copyAllowed

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

deepLinkAllowed

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

disconnectTimeoutInMinutes

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

downloadAllowed

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

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.

pasteAllowed

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

printAllowed

Specifies whether the user can print to the local device.

uploadAllowed

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

userSettingsArn

[required] The ARN of the user settings.

Value

A list with the following syntax:

list(
  userSettings = list(
    additionalEncryptionContext = list(
      "string"
    ),
    associatedPortalArns = list(
      "string"
    ),
    cookieSynchronizationConfiguration = list(
      allowlist = list(
        list(
          domain = "string",
          name = "string",
          path = "string"
        )
      ),
      blocklist = list(
        list(
          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",
    uploadAllowed = "Disabled"|"Enabled",
    userSettingsArn = "string"
  )
)

Request syntax

svc$update_user_settings(
  clientToken = "string",
  cookieSynchronizationConfiguration = list(
    allowlist = list(
      list(
        domain = "string",
        name = "string",
        path = "string"
      )
    ),
    blocklist = list(
      list(
        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",
  uploadAllowed = "Disabled"|"Enabled",
  userSettingsArn = "string"
)