Amazon WorkSpaces · JSON Structure

Workspaces Update Result Structure

Describes whether a WorkSpace image needs to be updated with the latest drivers and other components required by Amazon WorkSpaces.

Only Windows 10 WorkSpace images can be programmatically updated at this time.

Type: object Properties: 2
DesktopEnd User ComputingVirtual DesktopDesktop as a Service

UpdateResult is a JSON Structure definition published by Amazon WorkSpaces, describing 2 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

UpdateAvailable Description

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

JSON Structure

Raw ↑ 
{
  "type": "object",
  "properties": {
    "UpdateAvailable": {
      "allOf": [
        {
          "$ref": "#/components/schemas/BooleanObject"
        },
        {
          "description": "Indicates whether updated drivers or other components are available for the specified WorkSpace image."
        }
      ]
    },
    "Description": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UpdateDescription"
        },
        {
          "description": "A description of whether updates for the WorkSpace image are pending or available."
        }
      ]
    }
  },
  "description": "<p>Describes whether a WorkSpace image needs to be updated with the latest drivers and other components required by Amazon WorkSpaces.</p> <note> <p>Only Windows 10 WorkSpace images can be programmatically updated at this time.</p> </note>",
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "name": "UpdateResult",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-workspaces/refs/heads/main/json-structure/workspaces-update-result-structure.json"
}