Amazon WorkSpaces · Schema

RelatedWorkspaceProperties

Describes the related WorkSpace. The related WorkSpace could be a standby WorkSpace or primary WorkSpace related to the specified WorkSpace.

DesktopEnd User ComputingVirtual DesktopDesktop as a Service

Properties

Name Type Description
WorkspaceId object
Region object
State object
Type object
View JSON Schema on GitHub

JSON Schema

workspaces-related-workspace-properties-schema.json Raw ↑
{
  "type": "object",
  "properties": {
    "WorkspaceId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WorkspaceId"
        },
        {
          "description": "The identifier of the related WorkSpace."
        }
      ]
    },
    "Region": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Region"
        },
        {
          "description": "The Region of the related WorkSpace."
        }
      ]
    },
    "State": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WorkspaceState"
        },
        {
          "description": "Indicates the state of the WorkSpace."
        }
      ]
    },
    "Type": {
      "allOf": [
        {
          "$ref": "#/components/schemas/StandbyWorkspaceRelationshipType"
        },
        {
          "description": "Indicates the type of WorkSpace."
        }
      ]
    }
  },
  "description": "Describes the related WorkSpace. The related WorkSpace could be a standby WorkSpace or primary WorkSpace related to the specified WorkSpace.",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "RelatedWorkspaceProperties",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-workspaces/refs/heads/main/json-schema/workspaces-related-workspace-properties-schema.json"
}