Skip to content

/AWS1/IF_WST=>UPDATEENVIRONMENT()

About UpdateEnvironment

Updates an environment.

Method Signature

METHODS /AWS1/IF_WST~UPDATEENVIRONMENT
  IMPORTING
    !IV_ID TYPE /AWS1/WSTENVIRONMENTID OPTIONAL
    !IV_NAME TYPE /AWS1/WSTENVIRONMENTNAME OPTIONAL
    !IV_DESKTOPARN TYPE /AWS1/WSTARN OPTIONAL
    !IV_DESKTOPENDPOINT TYPE /AWS1/WSTDESKTOPENDPOINT OPTIONAL
    !IV_SOFTWARESETUPDATESCHEDULE TYPE /AWS1/WSTSOFTWARESETUPDATESCHD OPTIONAL
    !IO_MAINTENANCEWINDOW TYPE REF TO /AWS1/CL_WSTMAINTENANCEWINDOW OPTIONAL
    !IV_SOFTWARESETUPDATEMODE TYPE /AWS1/WSTSOFTWARESETUPDATEMODE OPTIONAL
    !IV_DESIREDSOFTWARESETID TYPE /AWS1/WSTSOFTWARESETIDOREMPT00 OPTIONAL
    !IT_DEVICECREATIONTAGS TYPE /AWS1/CL_WSTDEVCREATIONTGSMA00=>TT_DEVICECREATIONTAGSMAP OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_wstupdenvironmentrsp
  RAISING
    /AWS1/CX_WSTACCESSDENIEDEX
    /AWS1/CX_WSTCONFLICTEXCEPTION
    /AWS1/CX_WSTINTERNALSERVEREX
    /AWS1/CX_WSTRESOURCENOTFOUNDEX
    /AWS1/CX_WSTTHROTTLINGEX
    /AWS1/CX_WSTVALIDATIONEX
    /AWS1/CX_WSTCLIENTEXC
    /AWS1/CX_WSTSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_id TYPE /AWS1/WSTENVIRONMENTID /AWS1/WSTENVIRONMENTID

The ID of the environment to update.

Optional arguments:

iv_name TYPE /AWS1/WSTENVIRONMENTNAME /AWS1/WSTENVIRONMENTNAME

The name of the environment to update.

iv_desktoparn TYPE /AWS1/WSTARN /AWS1/WSTARN

The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Secure Browser, or AppStream 2.0.

iv_desktopendpoint TYPE /AWS1/WSTDESKTOPENDPOINT /AWS1/WSTDESKTOPENDPOINT

The URL for the identity provider login (only for environments that use AppStream 2.0).

iv_softwaresetupdateschedule TYPE /AWS1/WSTSOFTWARESETUPDATESCHD /AWS1/WSTSOFTWARESETUPDATESCHD

An option to define if software updates should be applied within a maintenance window.

io_maintenancewindow TYPE REF TO /AWS1/CL_WSTMAINTENANCEWINDOW /AWS1/CL_WSTMAINTENANCEWINDOW

A specification for a time window to apply software updates.

iv_softwaresetupdatemode TYPE /AWS1/WSTSOFTWARESETUPDATEMODE /AWS1/WSTSOFTWARESETUPDATEMODE

An option to define which software updates to apply.

iv_desiredsoftwaresetid TYPE /AWS1/WSTSOFTWARESETIDOREMPT00 /AWS1/WSTSOFTWARESETIDOREMPT00

The ID of the software set to apply.

it_devicecreationtags TYPE /AWS1/CL_WSTDEVCREATIONTGSMA00=>TT_DEVICECREATIONTAGSMAP TT_DEVICECREATIONTAGSMAP

A map of the key-value pairs of the tag or tags to assign to the newly created devices for this environment.

RETURNING

oo_output TYPE REF TO /aws1/cl_wstupdenvironmentrsp /AWS1/CL_WSTUPDENVIRONMENTRSP

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->updateenvironment(
  io_maintenancewindow = new /aws1/cl_wstmaintenancewindow(
    it_daysoftheweek = VALUE /aws1/cl_wstdayofweeklist_w=>tt_dayofweeklist(
      ( new /aws1/cl_wstdayofweeklist_w( |string| ) )
    )
    iv_applytimeof = |string|
    iv_endtimehour = 123
    iv_endtimeminute = 123
    iv_starttimehour = 123
    iv_starttimeminute = 123
    iv_type = |string|
  )
  it_devicecreationtags = VALUE /aws1/cl_wstdevcreationtgsma00=>tt_devicecreationtagsmap(
    (
      VALUE /aws1/cl_wstdevcreationtgsma00=>ts_devcreationtagsmap_maprow(
        key = |string|
        value = new /aws1/cl_wstdevcreationtgsma00( |string| )
      )
    )
  )
  iv_desiredsoftwaresetid = |string|
  iv_desktoparn = |string|
  iv_desktopendpoint = |string|
  iv_id = |string|
  iv_name = |string|
  iv_softwaresetupdatemode = |string|
  iv_softwaresetupdateschedule = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_environmentsummary = lo_result->get_environment( ).
  IF lo_environmentsummary IS NOT INITIAL.
    lv_environmentid = lo_environmentsummary->get_id( ).
    lv_environmentname = lo_environmentsummary->get_name( ).
    lv_arn = lo_environmentsummary->get_desktoparn( ).
    lv_desktopendpoint = lo_environmentsummary->get_desktopendpoint( ).
    lv_desktoptype = lo_environmentsummary->get_desktoptype( ).
    lv_activationcode = lo_environmentsummary->get_activationcode( ).
    lv_softwaresetupdateschedu = lo_environmentsummary->get_softwaresetupdateschd( ).
    lo_maintenancewindow = lo_environmentsummary->get_maintenancewindow( ).
    IF lo_maintenancewindow IS NOT INITIAL.
      lv_maintenancewindowtype = lo_maintenancewindow->get_type( ).
      lv_hour = lo_maintenancewindow->get_starttimehour( ).
      lv_minute = lo_maintenancewindow->get_starttimeminute( ).
      lv_hour = lo_maintenancewindow->get_endtimehour( ).
      lv_minute = lo_maintenancewindow->get_endtimeminute( ).
      LOOP AT lo_maintenancewindow->get_daysoftheweek( ) into lo_row.
        lo_row_1 = lo_row.
        IF lo_row_1 IS NOT INITIAL.
          lv_dayofweek = lo_row_1->get_value( ).
        ENDIF.
      ENDLOOP.
      lv_applytimeof = lo_maintenancewindow->get_applytimeof( ).
    ENDIF.
    lv_softwaresetupdatemode = lo_environmentsummary->get_softwaresetupdatemode( ).
    lv_softwaresetid = lo_environmentsummary->get_desiredsoftwaresetid( ).
    lv_softwaresetid = lo_environmentsummary->get_pendingsoftwaresetid( ).
    lv_timestamp = lo_environmentsummary->get_createdat( ).
    lv_timestamp = lo_environmentsummary->get_updatedat( ).
    lv_arn = lo_environmentsummary->get_arn( ).
  ENDIF.
ENDIF.