Skip to content

Import Custom Workspace Image

workspaces_import_custom_workspace_image R Documentation

Imports the specified Windows 10 or 11 Bring Your Own License (BYOL) image into Amazon WorkSpaces using EC2 Image Builder

Description

Imports the specified Windows 10 or 11 Bring Your Own License (BYOL) image into Amazon WorkSpaces using EC2 Image Builder. The image must be an already licensed image that is in your Amazon Web Services account, and you must own the image. For more information about creating BYOL images, see Bring Your Own Windows Desktop Licenses.

Usage

workspaces_import_custom_workspace_image(ImageName, ImageDescription,
  ComputeType, Protocol, ImageSource, InfrastructureConfigurationArn,
  Platform, OsVersion, Tags)

Arguments

ImageName

[required] The name of the WorkSpace image.
ImageDescription

[required] The description of the WorkSpace image.
ComputeType

[required] The supported compute type for the WorkSpace image.
Protocol

[required] The supported protocol for the WorkSpace image. Windows 11 does not support PCOIP protocol.
ImageSource

[required] The options for image import source.
InfrastructureConfigurationArn

[required] The infrastructure configuration ARN that specifies how the WorkSpace image is built.
Platform

[required] The platform for the WorkSpace image source.
OsVersion

[required] The OS version for the WorkSpace image source.
Tags

The resource tags. Each WorkSpaces resource can have a maximum of 50 tags.

Value

A list with the following syntax:

list(
  ImageId = "string",
  State = "PENDING"|"IN_PROGRESS"|"PROCESSING_SOURCE_IMAGE"|"IMAGE_TESTING_START"|"UPDATING_OPERATING_SYSTEM"|"IMAGE_COMPATIBILITY_CHECKING"|"IMAGE_TESTING_GENERALIZATION"|"CREATING_TEST_INSTANCE"|"INSTALLING_COMPONENTS"|"GENERALIZING"|"VALIDATING"|"PUBLISHING"|"COMPLETED"|"ERROR"
)

Request syntax

svc$import_custom_workspace_image(
  ImageName = "string",
  ImageDescription = "string",
  ComputeType = "BASE"|"GRAPHICS_G4DN"|"GRAPHICS_G6",
  Protocol = "PCOIP"|"DCV"|"BYOP",
  ImageSource = list(
    Ec2ImportTaskId = "string",
    ImageBuildVersionArn = "string",
    Ec2ImageId = "string"
  ),
  InfrastructureConfigurationArn = "string",
  Platform = "WINDOWS",
  OsVersion = "Windows_10"|"Windows_11",
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  )
)