Skip to content

/AWS1/IF_CAT=>UPDATEDEVENVIRONMENT()

About UpdateDevEnvironment

Changes one or more values for a Dev Environment. Updating certain values of the Dev Environment will cause a restart.

Method Signature

METHODS /AWS1/IF_CAT~UPDATEDEVENVIRONMENT
  IMPORTING
    !IV_SPACENAME TYPE /AWS1/CATNAMESTRING OPTIONAL
    !IV_PROJECTNAME TYPE /AWS1/CATNAMESTRING OPTIONAL
    !IV_ID TYPE /AWS1/CATUUID OPTIONAL
    !IV_ALIAS TYPE /AWS1/CATSTRING OPTIONAL
    !IT_IDES TYPE /AWS1/CL_CATIDECONFIGURATION=>TT_IDECONFIGURATIONLIST OPTIONAL
    !IV_INSTANCETYPE TYPE /AWS1/CATINSTANCETYPE OPTIONAL
    !IV_INACTIVITYTIMEOUTMINUTES TYPE /AWS1/CATINACTIVITYTMOUTMINS OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/CATCLIENTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_catupdevenvironment01
  RAISING
    /AWS1/CX_CATACCESSDENIEDEX
    /AWS1/CX_CATCONFLICTEXCEPTION
    /AWS1/CX_CATRESOURCENOTFOUNDEX
    /AWS1/CX_CATSERVICEQUOTAEXCDEX
    /AWS1/CX_CATTHROTTLINGEX
    /AWS1/CX_CATVALIDATIONEX
    /AWS1/CX_CATCLIENTEXC
    /AWS1/CX_CATSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_spacename TYPE /AWS1/CATNAMESTRING /AWS1/CATNAMESTRING

The name of the space.

iv_projectname TYPE /AWS1/CATNAMESTRING /AWS1/CATNAMESTRING

The name of the project in the space.

iv_id TYPE /AWS1/CATUUID /AWS1/CATUUID

The system-generated unique ID of the Dev Environment.

Optional arguments:

iv_alias TYPE /AWS1/CATSTRING /AWS1/CATSTRING

The user-specified alias for the Dev Environment. Changing this value will not cause a restart.

it_ides TYPE /AWS1/CL_CATIDECONFIGURATION=>TT_IDECONFIGURATIONLIST TT_IDECONFIGURATIONLIST

Information about the integrated development environment (IDE) configured for a Dev Environment.

iv_instancetype TYPE /AWS1/CATINSTANCETYPE /AWS1/CATINSTANCETYPE

The Amazon EC2 instace type to use for the Dev Environment.

Changing this value will cause a restart of the Dev Environment if it is running.

iv_inactivitytimeoutminutes TYPE /AWS1/CATINACTIVITYTMOUTMINS /AWS1/CATINACTIVITYTMOUTMINS

The amount of time the Dev Environment will run without any activity detected before stopping, in minutes. Only whole integers are allowed. Dev Environments consume compute minutes when running.

Changing this value will cause a restart of the Dev Environment if it is running.

iv_clienttoken TYPE /AWS1/CATCLIENTTOKEN /AWS1/CATCLIENTTOKEN

A user-specified idempotency token. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries return the result from the original successful request and have no additional effect.

RETURNING

oo_output TYPE REF TO /aws1/cl_catupdevenvironment01 /AWS1/CL_CATUPDEVENVIRONMENT01

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->updatedevenvironment(
  it_ides = VALUE /aws1/cl_catideconfiguration=>tt_ideconfigurationlist(
    (
      new /aws1/cl_catideconfiguration(
        iv_name = |string|
        iv_runtime = |string|
      )
    )
  )
  iv_alias = |string|
  iv_clienttoken = |string|
  iv_id = |string|
  iv_inactivitytimeoutminutes = 123
  iv_instancetype = |string|
  iv_projectname = |string|
  iv_spacename = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_uuid = lo_result->get_id( ).
  lv_namestring = lo_result->get_spacename( ).
  lv_namestring = lo_result->get_projectname( ).
  lv_string = lo_result->get_alias( ).
  LOOP AT lo_result->get_ides( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_string = lo_row_1->get_runtime( ).
      lv_string = lo_row_1->get_name( ).
    ENDIF.
  ENDLOOP.
  lv_instancetype = lo_result->get_instancetype( ).
  lv_inactivitytimeoutminute = lo_result->get_inactivitytimeoutminutes( ).
  lv_clienttoken = lo_result->get_clienttoken( ).
ENDIF.