List User Settings

workspacesweb_list_user_settings

R Documentation

Retrieves a list of user settings

Description

Retrieves a list of user settings.

Usage

workspacesweb_list_user_settings(nextToken, maxResults)

Arguments

nextToken	The pagination token used to retrieve the next page of results for this operation.
maxResults	The maximum number of results to be included in the next page.

Value

A list with the following syntax:

list(
  userSettings = list(
    list(
      userSettingsArn = "string",
      copyAllowed = "Disabled"|"Enabled",
      pasteAllowed = "Disabled"|"Enabled",
      downloadAllowed = "Disabled"|"Enabled",
      uploadAllowed = "Disabled"|"Enabled",
      printAllowed = "Disabled"|"Enabled",
      disconnectTimeoutInMinutes = 123,
      idleDisconnectTimeoutInMinutes = 123,
      cookieSynchronizationConfiguration = list(
        allowlist = list(
          list(
            domain = "string",
            name = "string",
            path = "string"
          )
        ),
        blocklist = list(
          list(
            domain = "string",
            name = "string",
            path = "string"
          )
        )
      ),
      deepLinkAllowed = "Disabled"|"Enabled",
      toolbarConfiguration = list(
        toolbarType = "Floating"|"Docked",
        visualMode = "Dark"|"Light",
        hiddenToolbarItems = list(
          "Windows"|"DualMonitor"|"FullScreen"|"Webcam"|"Microphone"
        ),
        maxDisplayResolution = "size4096X2160"|"size3840X2160"|"size3440X1440"|"size2560X1440"|"size1920X1080"|"size1280X720"|"size1024X768"|"size800X600"
      ),
      brandingConfiguration = list(
        logo = list(
          mimeType = "image/png"|"image/jpeg"|"image/x-icon",
          fileExtension = "string",
          lastUploadTimestamp = as.POSIXct(
            "2015-01-01"
          )
        ),
        wallpaper = list(
          mimeType = "image/png"|"image/jpeg"|"image/x-icon",
          fileExtension = "string",
          lastUploadTimestamp = as.POSIXct(
            "2015-01-01"
          )
        ),
        favicon = list(
          mimeType = "image/png"|"image/jpeg"|"image/x-icon",
          fileExtension = "string",
          lastUploadTimestamp = as.POSIXct(
            "2015-01-01"
          )
        ),
        localizedStrings = list(
          list(
            browserTabTitle = "string",
            welcomeText = "string",
            loginTitle = "string",
            loginDescription = "string",
            loginButtonText = "string",
            contactLink = "string",
            contactButtonText = "string",
            loadingText = "string"
          )
        ),
        colorTheme = "Light"|"Dark",
        termsOfService = "string"
      ),
      webAuthnAllowed = "Disabled"|"Enabled"
    )
  ),
  nextToken = "string"
)

Request syntax

svc$list_user_settings(
  nextToken = "string",
  maxResults = 123
)