Skip to content

/AWS1/IF_WSP=>IMPORTCUSTOMWORKSPACEIMAGE()

About ImportCustomWorkspaceImage

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.

Method Signature

IMPORTING

Required arguments:

iv_imagename TYPE /AWS1/WSPWORKSPACEIMAGENAME /AWS1/WSPWORKSPACEIMAGENAME

The name of the WorkSpace image.

iv_imagedescription TYPE /AWS1/WSPWORKSPACEIMAGEDESC /AWS1/WSPWORKSPACEIMAGEDESC

The description of the WorkSpace image.

iv_computetype TYPE /AWS1/WSPIMAGECOMPUTETYPE /AWS1/WSPIMAGECOMPUTETYPE

The supported compute type for the WorkSpace image.

iv_protocol TYPE /AWS1/WSPCUSTOMIMAGEPROTOCOL /AWS1/WSPCUSTOMIMAGEPROTOCOL

The supported protocol for the WorkSpace image. Windows 11 does not support PCOIP protocol.

io_imagesource TYPE REF TO /AWS1/CL_WSPIMAGESOURCEID /AWS1/CL_WSPIMAGESOURCEID

The options for image import source.

iv_infrastructureconfarn TYPE /AWS1/WSPINFRASTRUCTURECONFARN /AWS1/WSPINFRASTRUCTURECONFARN

The infrastructure configuration ARN that specifies how the WorkSpace image is built.

iv_platform TYPE /AWS1/WSPPLATFORM /AWS1/WSPPLATFORM

The platform for the WorkSpace image source.

iv_osversion TYPE /AWS1/WSPOSVERSION /AWS1/WSPOSVERSION

The OS version for the WorkSpace image source.

Optional arguments:

it_tags TYPE /AWS1/CL_WSPTAG=>TT_TAGLIST TT_TAGLIST

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

RETURNING

oo_output TYPE REF TO /aws1/cl_wspimpcustworkspace01 /AWS1/CL_WSPIMPCUSTWORKSPACE01

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->/aws1/if_wsp~importcustomworkspaceimage(
  io_imagesource = new /aws1/cl_wspimagesourceid(
    iv_ec2imageid = |string|
    iv_ec2importtaskid = |string|
    iv_imagebuildversionarn = |string|
  )
  it_tags = VALUE /aws1/cl_wsptag=>tt_taglist(
    (
      new /aws1/cl_wsptag(
        iv_key = |string|
        iv_value = |string|
      )
    )
  )
  iv_computetype = |string|
  iv_imagedescription = |string|
  iv_imagename = |string|
  iv_infrastructureconfarn = |string|
  iv_osversion = |string|
  iv_platform = |string|
  iv_protocol = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_workspaceimageid = lo_result->get_imageid( ).
  lv_customworkspaceimageimp = lo_result->get_state( ).
ENDIF.