Amazon WorkSpaces Web · JSON Structure

Workspaces Web User Settings Structure

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.

Type: object Properties: 9 Required: 1
End User ComputingSecure BrowserVirtual DesktopZero Trust

UserSettings is a JSON Structure definition published by Amazon WorkSpaces Web, describing 9 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

associatedPortalArns copyAllowed disconnectTimeoutInMinutes downloadAllowed idleDisconnectTimeoutInMinutes pasteAllowed printAllowed uploadAllowed userSettingsArn

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "type": "object",
  "required": [
    "userSettingsArn"
  ],
  "properties": {
    "associatedPortalArns": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ArnList"
        },
        {
          "description": "A list of web portal ARNs that this user settings is associated with."
        }
      ]
    },
    "copyAllowed": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EnabledType"
        },
        {
          "description": "Specifies whether the user can copy text from the streaming session to the local device."
        }
      ]
    },
    "disconnectTimeoutInMinutes": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DisconnectTimeoutInMinutes"
        },
        {
          "description": "The amount of time that a streaming session remains active after users disconnect."
        }
      ]
    },
    "downloadAllowed": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EnabledType"
        },
        {
          "description": "Specifies whether the user can download files from the streaming session to the local device."
        }
      ]
    },
    "idleDisconnectTimeoutInMinutes": {
      "allOf": [
        {
          "$ref": "#/components/schemas/IdleDisconnectTimeoutInMinutes"
        },
        {
          "description": "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": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EnabledType"
        },
        {
          "description": "Specifies whether the user can paste text from the local device to the streaming session."
        }
      ]
    },
    "printAllowed": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EnabledType"
        },
        {
          "description": "Specifies whether the user can print to the local device."
        }
      ]
    },
    "uploadAllowed": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EnabledType"
        },
        {
          "description": "Specifies whether the user can upload files from the local device to the streaming session."
        }
      ]
    },
    "userSettingsArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ARN"
        },
        {
          "description": "The ARN of the user settings."
        }
      ]
    }
  },
  "description": "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. ",
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "name": "UserSettings",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-workspaces-web/refs/heads/main/json-structure/workspaces-web-user-settings-structure.json"
}