/AWS1/IF_WSP=>UPDATEWORKSPACESPOOL()

About UpdateWorkspacesPool

Updates the specified pool.

Method Signature

METHODS /AWS1/IF_WSP~UPDATEWORKSPACESPOOL
  IMPORTING
    !IV_POOLID TYPE /AWS1/WSPWORKSPACESPOOLID OPTIONAL
    !IV_DESCRIPTION TYPE /AWS1/WSPUPDATEDESCRIPTION OPTIONAL
    !IV_BUNDLEID TYPE /AWS1/WSPBUNDLEID OPTIONAL
    !IV_DIRECTORYID TYPE /AWS1/WSPDIRECTORYID OPTIONAL
    !IO_CAPACITY TYPE REF TO /AWS1/CL_WSPCAPACITY OPTIONAL
    !IO_APPLICATIONSETTINGS TYPE REF TO /AWS1/CL_WSPAPPLICATIONSTGSREQ OPTIONAL
    !IO_TIMEOUTSETTINGS TYPE REF TO /AWS1/CL_WSPTIMEOUTSETTINGS OPTIONAL
    !IV_RUNNINGMODE TYPE /AWS1/WSPPOOLSRUNNINGMODE OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_wspupworkspacespoolrs
  RAISING
    /AWS1/CX_WSPACCESSDENIEDEX
    /AWS1/CX_WSPINVPARAMVALUESEX
    /AWS1/CX_WSPINVRESOURCESTATEEX
    /AWS1/CX_WSPOPINPROGRESSEX
    /AWS1/CX_WSPOPNOTSUPPORTEDEX
    /AWS1/CX_WSPRESRCLIMITEXCDEX
    /AWS1/CX_WSPRESOURCENOTFOUNDEX
    /AWS1/CX_WSPCLIENTEXC
    /AWS1/CX_WSPSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_poolid TYPE /AWS1/WSPWORKSPACESPOOLID /AWS1/WSPWORKSPACESPOOLID

The identifier of the specified pool to update.

Optional arguments:

iv_description TYPE /AWS1/WSPUPDATEDESCRIPTION /AWS1/WSPUPDATEDESCRIPTION

Describes the specified pool to update.

iv_bundleid TYPE /AWS1/WSPBUNDLEID /AWS1/WSPBUNDLEID

The identifier of the bundle.

iv_directoryid TYPE /AWS1/WSPDIRECTORYID /AWS1/WSPDIRECTORYID

The identifier of the directory.

io_capacity TYPE REF TO /AWS1/CL_WSPCAPACITY /AWS1/CL_WSPCAPACITY

The desired capacity for the pool.

io_applicationsettings TYPE REF TO /AWS1/CL_WSPAPPLICATIONSTGSREQ /AWS1/CL_WSPAPPLICATIONSTGSREQ

The persistent application settings for users in the pool.

io_timeoutsettings TYPE REF TO /AWS1/CL_WSPTIMEOUTSETTINGS /AWS1/CL_WSPTIMEOUTSETTINGS

Indicates the timeout settings of the specified pool.

iv_runningmode TYPE /AWS1/WSPPOOLSRUNNINGMODE /AWS1/WSPPOOLSRUNNINGMODE

The desired running mode for the pool. The running mode can only be updated when the pool is in a stopped state.

RETURNING

oo_output TYPE REF TO /aws1/cl_wspupworkspacespoolrs /AWS1/CL_WSPUPWORKSPACESPOOLRS

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->updateworkspacespool(
  io_applicationsettings = new /aws1/cl_wspapplicationstgsreq(
    iv_settingsgroup = |string|
    iv_status = |string|
  )
  io_capacity = new /aws1/cl_wspcapacity( 123 )
  io_timeoutsettings = new /aws1/cl_wsptimeoutsettings(
    iv_discncttimeoutinseconds = 123
    iv_idlediscncttmoutinseconds = 123
    iv_maxuserdurationinseconds = 123
  )
  iv_bundleid = |string|
  iv_description = |string|
  iv_directoryid = |string|
  iv_poolid = |string|
  iv_runningmode = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_workspacespool = lo_result->get_workspacespool( ).
  IF lo_workspacespool IS NOT INITIAL.
    lv_workspacespoolid = lo_workspacespool->get_poolid( ).
    lv_arn = lo_workspacespool->get_poolarn( ).
    lo_capacitystatus = lo_workspacespool->get_capacitystatus( ).
    IF lo_capacitystatus IS NOT INITIAL.
      lv_availableusersessions = lo_capacitystatus->get_availableusersessions( ).
      lv_desiredusersessions = lo_capacitystatus->get_desiredusersessions( ).
      lv_actualusersessions = lo_capacitystatus->get_actualusersessions( ).
      lv_activeusersessions = lo_capacitystatus->get_activeusersessions( ).
    ENDIF.
    lv_workspacespoolname = lo_workspacespool->get_poolname( ).
    lv_updatedescription = lo_workspacespool->get_description( ).
    lv_workspacespoolstate = lo_workspacespool->get_state( ).
    lv_timestamp = lo_workspacespool->get_createdat( ).
    lv_bundleid = lo_workspacespool->get_bundleid( ).
    lv_directoryid = lo_workspacespool->get_directoryid( ).
    LOOP AT lo_workspacespool->get_errors( ) into lo_row.
      lo_row_1 = lo_row.
      IF lo_row_1 IS NOT INITIAL.
        lv_workspacespoolerrorcode = lo_row_1->get_errorcode( ).
        lv_errormessage = lo_row_1->get_errormessage( ).
      ENDIF.
    ENDLOOP.
    lo_applicationsettingsresp = lo_workspacespool->get_applicationsettings( ).
    IF lo_applicationsettingsresp IS NOT INITIAL.
      lv_applicationsettingsstat = lo_applicationsettingsresp->get_status( ).
      lv_settingsgroup = lo_applicationsettingsresp->get_settingsgroup( ).
      lv_s3bucketname = lo_applicationsettingsresp->get_s3bucketname( ).
    ENDIF.
    lo_timeoutsettings = lo_workspacespool->get_timeoutsettings( ).
    IF lo_timeoutsettings IS NOT INITIAL.
      lv_disconnecttimeoutinseco = lo_timeoutsettings->get_discncttimeoutinseconds( ).
      lv_idledisconnecttimeoutin = lo_timeoutsettings->get_idlediscncttmoutinsecs( ).
      lv_maxuserdurationinsecond = lo_timeoutsettings->get_maxuserdurationinseconds( ).
    ENDIF.
    lv_poolsrunningmode = lo_workspacespool->get_runningmode( ).
  ENDIF.
ENDIF.