Amazon WorkSpaces · JSON Structure

Workspaces Create Updated Workspace Image Request Structure

CreateUpdatedWorkspaceImageRequest schema from Amazon WorkSpaces API

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

CreateUpdatedWorkspaceImageRequest 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 SourceImageId Tags

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

JSON Structure

Raw ↑ 
{
  "type": "object",
  "required": [
    "Name",
    "Description",
    "SourceImageId"
  ],
  "name": "CreateUpdatedWorkspaceImageRequest",
  "properties": {
    "Name": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WorkspaceImageName"
        },
        {
          "description": "The name of the new updated WorkSpace image."
        }
      ]
    },
    "Description": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WorkspaceImageDescription"
        },
        {
          "description": "A description of whether updates for the WorkSpace image are available."
        }
      ]
    },
    "SourceImageId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WorkspaceImageId"
        },
        {
          "description": "The identifier of the source WorkSpace image."
        }
      ]
    },
    "Tags": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TagList"
        },
        {
          "description": "<p>The tags that you want to add to the new updated WorkSpace image.</p> <note> <p>To add tags at the same time when you're creating the updated image, you must create an IAM policy that grants your IAM user permissions to use <code>workspaces:CreateTags</code>. </p> </note>"
        }
      ]
    }
  },
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-workspaces/refs/heads/main/json-structure/workspaces-create-updated-workspace-image-request-structure.json",
  "description": "CreateUpdatedWorkspaceImageRequest schema from Amazon WorkSpaces API"
}