Amazon WorkSpaces · Schema

CreateWorkspaceImageRequest

CreateWorkspaceImageRequest schema from Amazon WorkSpaces API

DesktopEnd User ComputingVirtual DesktopDesktop as a Service

Properties

Name Type Description
Name object
Description object
WorkspaceId object
Tags object
View JSON Schema on GitHub

JSON Schema

workspaces-create-workspace-image-request-schema.json Raw ↑
{
  "type": "object",
  "required": [
    "Name",
    "Description",
    "WorkspaceId"
  ],
  "title": "CreateWorkspaceImageRequest",
  "properties": {
    "Name": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WorkspaceImageName"
        },
        {
          "description": "The name of the new WorkSpace image."
        }
      ]
    },
    "Description": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WorkspaceImageDescription"
        },
        {
          "description": "The description of the new WorkSpace image."
        }
      ]
    },
    "WorkspaceId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WorkspaceId"
        },
        {
          "description": "The identifier of the source WorkSpace"
        }
      ]
    },
    "Tags": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TagList"
        },
        {
          "description": "The tags that you want to add to the new WorkSpace image. To add tags when you're creating the image, you must create an IAM policy that grants your IAM user permission to use <code>workspaces:CreateTags</code>."
        }
      ]
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-workspaces/refs/heads/main/json-schema/workspaces-create-workspace-image-request-schema.json",
  "description": "CreateWorkspaceImageRequest schema from Amazon WorkSpaces API"
}