CREATEUPDATEDWORKSPACEIMAGE()`¶

About CreateUpdatedWorkspaceImage¶

Creates a new updated WorkSpace image based on the specified source image. The new updated WorkSpace image has the latest drivers and other updates required by the Amazon WorkSpaces components.

To determine which WorkSpace images need to be updated with the latest Amazon WorkSpaces requirements, use DescribeWorkspaceImages.

Only Windows 10, Windows Server 2016, and Windows Server 2019 WorkSpace images can be programmatically updated at this time.
Microsoft Windows updates and other application updates are not included in the update process.
The source WorkSpace image is not deleted. You can delete the source image after you've verified your new updated image and created a new bundle.

Method Signature¶

IMPORTING¶

Required arguments:¶

`iv_name` `TYPE /AWS1/WSPWORKSPACEIMAGENAME` `/AWS1/WSPWORKSPACEIMAGENAME`¶

The name of the new updated WorkSpace image.

`iv_description` `TYPE /AWS1/WSPWORKSPACEIMAGEDESC` `/AWS1/WSPWORKSPACEIMAGEDESC`¶

A description of whether updates for the WorkSpace image are available.

`iv_sourceimageid` `TYPE /AWS1/WSPWORKSPACEIMAGEID` `/AWS1/WSPWORKSPACEIMAGEID`¶

The identifier of the source WorkSpace image.

Optional arguments:¶

`it_tags` `TYPE /AWS1/CL_WSPTAG=>TT_TAGLIST` `TT_TAGLIST`¶

The tags that you want to add to the new updated WorkSpace image.

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 workspaces:CreateTags.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_wspcreupdworkspacei01` `/AWS1/CL_WSPCREUPDWORKSPACEI01`¶

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~createupdatedworkspaceimage(
  it_tags = VALUE /aws1/cl_wsptag=>tt_taglist(
    (
      new /aws1/cl_wsptag(
        iv_key = |string|
        iv_value = |string|
      )
    )
  )
  iv_description = |string|
  iv_name = |string|
  iv_sourceimageid = |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( ).
ENDIF.

/AWS1/CL_WSP=>CREATEUPDATEDWORKSPACEIMAGE()¶