Skip to content

/AWS1/IF_M2=>UPDATEENVIRONMENT()

About UpdateEnvironment

Updates the configuration details for a specific runtime environment.

Method Signature

METHODS /AWS1/IF_M2~UPDATEENVIRONMENT
  IMPORTING
    !IV_ENVIRONMENTID TYPE /AWS1/M2_IDENTIFIER OPTIONAL
    !IV_DESIREDCAPACITY TYPE /AWS1/M2_CAPACITYVALUE OPTIONAL
    !IV_INSTANCETYPE TYPE /AWS1/M2_STRING20 OPTIONAL
    !IV_ENGINEVERSION TYPE /AWS1/M2_ENGINEVERSION OPTIONAL
    !IV_PREFERREDMAINTENANCEWIN00 TYPE /AWS1/M2_STRING OPTIONAL
    !IV_APPLYDURINGMAINTENANCEW00 TYPE /AWS1/M2_BOOLEAN OPTIONAL
    !IV_FORCEUPDATE TYPE /AWS1/M2_BOOLEAN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_m2_updenvironmentrsp
  RAISING
    /AWS1/CX_M2_ACCESSDENIEDEX
    /AWS1/CX_M2_CONFLICTEXCEPTION
    /AWS1/CX_M2_INTERNALSERVEREX
    /AWS1/CX_M2_RESOURCENOTFOUNDEX
    /AWS1/CX_M2_SERVICEQUOTAEXCDEX
    /AWS1/CX_M2_THROTTLINGEX
    /AWS1/CX_M2_VALIDATIONEX
    /AWS1/CX_M2_CLIENTEXC
    /AWS1/CX_M2_SERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_environmentid TYPE /AWS1/M2_IDENTIFIER /AWS1/M2_IDENTIFIER

The unique identifier of the runtime environment that you want to update.

Optional arguments:

iv_desiredcapacity TYPE /AWS1/M2_CAPACITYVALUE /AWS1/M2_CAPACITYVALUE

The desired capacity for the runtime environment to update. The minimum possible value is 0 and the maximum is 100.

iv_instancetype TYPE /AWS1/M2_STRING20 /AWS1/M2_STRING20

The instance type for the runtime environment to update.

iv_engineversion TYPE /AWS1/M2_ENGINEVERSION /AWS1/M2_ENGINEVERSION

The version of the runtime engine for the runtime environment.

iv_preferredmaintenancewin00 TYPE /AWS1/M2_STRING /AWS1/M2_STRING

Configures the maintenance window that you want for the runtime environment. The maintenance window must have the format ddd:hh24:mi-ddd:hh24:mi and must be less than 24 hours. The following two examples are valid maintenance windows: sun:23:45-mon:00:15 or sat:01:00-sat:03:00.

If you do not provide a value, a random system-generated value will be assigned.

iv_applyduringmaintenancew00 TYPE /AWS1/M2_BOOLEAN /AWS1/M2_BOOLEAN

Indicates whether to update the runtime environment during the maintenance window. The default is false. Currently, Amazon Web Services Mainframe Modernization accepts the engineVersion parameter only if applyDuringMaintenanceWindow is true. If any parameter other than engineVersion is provided in UpdateEnvironmentRequest, it will fail if applyDuringMaintenanceWindow is set to true.

iv_forceupdate TYPE /AWS1/M2_BOOLEAN /AWS1/M2_BOOLEAN

Forces the updates on the environment. This option is needed if the applications in the environment are not stopped or if there are ongoing application-related activities in the environment.

If you use this option, be aware that it could lead to data corruption in the applications, and that you might need to perform repair and recovery procedures for the applications.

This option is not needed if the attribute being updated is preferredMaintenanceWindow.

RETURNING

oo_output TYPE REF TO /aws1/cl_m2_updenvironmentrsp /AWS1/CL_M2_UPDENVIRONMENTRSP

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(
  iv_applyduringmaintenancew00 = ABAP_TRUE
  iv_desiredcapacity = 123
  iv_engineversion = |string|
  iv_environmentid = |string|
  iv_forceupdate = ABAP_TRUE
  iv_instancetype = |string|
  iv_preferredmaintenancewin00 = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_identifier = lo_result->get_environmentid( ).
ENDIF.