Amazon WorkSpaces · JSON Structure

Workspaces Create Workspace Image Request Structure

CreateWorkspaceImageRequest schema from Amazon WorkSpaces API

Type: object Properties: 4 Required: 3
DesktopEnd User ComputingVirtual DesktopDesktop as a Service

CreateWorkspaceImageRequest is a JSON Structure definition published by Amazon WorkSpaces, describing 4 properties, of which 3 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

Name Description WorkspaceId Tags

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

JSON Structure

Raw ↑ 
{
  "type": "object",
  "required": [
    "Name",
    "Description",
    "WorkspaceId"
  ],
  "name": "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-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-workspaces/refs/heads/main/json-structure/workspaces-create-workspace-image-request-structure.json",
  "description": "CreateWorkspaceImageRequest schema from Amazon WorkSpaces API"
}