Amazon WorkSpaces · Schema

FailedWorkspaceChangeRequest

Describes a WorkSpace that could not be rebooted. (RebootWorkspaces), rebuilt (RebuildWorkspaces), restored (RestoreWorkspace), terminated (TerminateWorkspaces), started (StartWorkspaces), or stopped (StopWorkspaces).

DesktopEnd User ComputingVirtual DesktopDesktop as a Service

Properties

Name Type Description
WorkspaceId object
ErrorCode object
ErrorMessage object
View JSON Schema on GitHub

JSON Schema

workspaces-failed-workspace-change-request-schema.json Raw ↑
{
  "type": "object",
  "properties": {
    "WorkspaceId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WorkspaceId"
        },
        {
          "description": "The identifier of the WorkSpace."
        }
      ]
    },
    "ErrorCode": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ErrorType"
        },
        {
          "description": "The error code that is returned if the WorkSpace cannot be rebooted."
        }
      ]
    },
    "ErrorMessage": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Description"
        },
        {
          "description": "The text of the error message that is returned if the WorkSpace cannot be rebooted."
        }
      ]
    }
  },
  "description": "Describes a WorkSpace that could not be rebooted. (<a>RebootWorkspaces</a>), rebuilt (<a>RebuildWorkspaces</a>), restored (<a>RestoreWorkspace</a>), terminated (<a>TerminateWorkspaces</a>), started (<a>StartWorkspaces</a>), or stopped (<a>StopWorkspaces</a>).",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "FailedWorkspaceChangeRequest",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-workspaces/refs/heads/main/json-schema/workspaces-failed-workspace-change-request-schema.json"
}