ImportWorkspaceImageRequest

{
  "type": "object",
  "required": [
    "Ec2ImageId",
    "IngestionProcess",
    "ImageName",
    "ImageDescription"
  ],
  "title": "ImportWorkspaceImageRequest",
  "properties": {
    "Ec2ImageId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Ec2ImageId"
        },
        {
          "description": "The identifier of the EC2 image."
        }
      ]
    },
    "IngestionProcess": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WorkspaceImageIngestionProcess"
        },
        {
          "description": "<p>The ingestion process to be used when importing the image, depending on which protocol you want to use for your BYOL Workspace image, either PCoIP, WorkSpaces Streaming Protocol (WSP), or bring your own protocol (BYOP). To use WSP, specify a value that ends in <code>_WSP</code>. To use PCoIP, specify a value that does not end in <code>_WSP</code>. To use BYOP, specify a value that ends in <code>_BYOP</code>.</p> <p>For non-GPU-enabled bundles (bundles other than Graphics or GraphicsPro), specify <code>BYOL_REGULAR</code>, <code>BYOL_REGULAR_WSP</code>, or <code>BYOL_REGULAR_BYOP</code>, depending on the protocol.</p> <note> <p>The <code>BYOL_REGULAR_BYOP</code> and <code>BYOL_GRAPHICS_G4DN_BYOP</code> values are only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use these values. For more information, see <a href=\"http://aws.amazon.com/workspaces/core/\">Amazon WorkSpaces Core</a>.</p> </note>"
        }
      ]
    },
    "ImageName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WorkspaceImageName"
        },
        {
          "description": "The name of the WorkSpace image."
        }
      ]
    },
    "ImageDescription": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WorkspaceImageDescription"
        },
        {
          "description": "The description of the WorkSpace image."
        }
      ]
    },
    "Tags": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TagList"
        },
        {
          "description": "The tags. Each WorkSpaces resource can have a maximum of 50 tags."
        }
      ]
    },
    "Applications": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ApplicationList"
        },
        {
          "description": "<p>If specified, the version of Microsoft Office to subscribe to. Valid only for Windows 10 and 11 BYOL images. For more information about subscribing to Office for BYOL images, see <a href=\"https://docs.aws.amazon.com/workspaces/latest/adminguide/byol-windows-images.html\"> Bring Your Own Windows Desktop Licenses</a>.</p> <note> <ul> <li> <p>Although this parameter is an array, only one item is allowed at this time.</p> </li> <li> <p>Windows 11 only supports <code>Microsoft_Office_2019</code>.</p> </li> </ul> </note>"
        }
      ]
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-workspaces/refs/heads/main/json-schema/workspaces-import-workspace-image-request-schema.json",
  "description": "ImportWorkspaceImageRequest schema from Amazon WorkSpaces API"
}