Amazon WorkSpaces Web · JSON Structure

Workspaces Web Create User Settings Request Structure

CreateUserSettingsRequest schema from Amazon WorkSpaces Web API

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

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

Properties

clientToken copyAllowed disconnectTimeoutInMinutes downloadAllowed idleDisconnectTimeoutInMinutes pasteAllowed printAllowed tags uploadAllowed

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

JSON Structure

Raw ↑
{
  "type": "object",
  "required": [
    "copyAllowed",
    "downloadAllowed",
    "pasteAllowed",
    "printAllowed",
    "uploadAllowed"
  ],
  "name": "CreateUserSettingsRequest",
  "properties": {
    "clientToken": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ClientToken"
        },
        {
          "description": "<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 AWS SDK.</p>"
        }
      ]
    },
    "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."
        }
      ]
    },
    "tags": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TagList"
        },
        {
          "description": "The tags to add to the user settings resource. A tag is a key-value pair."
        }
      ]
    },
    "uploadAllowed": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EnabledType"
        },
        {
          "description": "Specifies whether the user can upload files from the local device to the streaming session."
        }
      ]
    }
  },
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-workspaces-web/refs/heads/main/json-structure/workspaces-web-create-user-settings-request-structure.json",
  "description": "CreateUserSettingsRequest schema from Amazon WorkSpaces Web API"
}