Amazon WorkSpaces · Schema

UpdateResult

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.

DesktopEnd User ComputingVirtual DesktopDesktop as a Service

Properties

Name Type Description
UpdateAvailable object
Description object
View JSON Schema on GitHub

JSON Schema

workspaces-update-result-schema.json 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-schema.org/draft/2020-12/schema",
  "title": "UpdateResult",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-workspaces/refs/heads/main/json-schema/workspaces-update-result-schema.json"
}