Skip to content

/AWS1/IF_BTC=>UPDATECOMPUTEENVIRONMENT()

About UpdateComputeEnvironment

Updates an Batch compute environment.

Method Signature

METHODS /AWS1/IF_BTC~UPDATECOMPUTEENVIRONMENT
  IMPORTING
    !IV_COMPUTEENVIRONMENT TYPE /AWS1/BTCSTRING OPTIONAL
    !IV_STATE TYPE /AWS1/BTCCESTATE OPTIONAL
    !IV_UNMANAGEDVCPUS TYPE /AWS1/BTCINTEGER OPTIONAL
    !IO_COMPUTERESOURCES TYPE REF TO /AWS1/CL_BTCCOMPUTERESRCUPDATE OPTIONAL
    !IV_SERVICEROLE TYPE /AWS1/BTCSTRING OPTIONAL
    !IO_UPDATEPOLICY TYPE REF TO /AWS1/CL_BTCUPDATEPOLICY OPTIONAL
    !IV_CONTEXT TYPE /AWS1/BTCSTRING OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_btcupcomputeenviron01
  RAISING
    /AWS1/CX_BTCCLIENTEXCEPTION
    /AWS1/CX_BTCSERVEREXCEPTION
    /AWS1/CX_BTCCLIENTEXC
    /AWS1/CX_BTCSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_computeenvironment TYPE /AWS1/BTCSTRING /AWS1/BTCSTRING

The name or full Amazon Resource Name (ARN) of the compute environment to update.

Optional arguments:

iv_state TYPE /AWS1/BTCCESTATE /AWS1/BTCCESTATE

The state of the compute environment. Compute environments in the ENABLED state can accept jobs from a queue and scale in or out automatically based on the workload demand of its associated queues.

If the state is ENABLED, then the Batch scheduler can attempt to place jobs from an associated job queue on the compute resources within the environment. If the compute environment is managed, then it can scale its instances out or in automatically, based on the job queue demand.

If the state is DISABLED, then the Batch scheduler doesn't attempt to place jobs within the environment. Jobs in a STARTING or RUNNING state continue to progress normally. Managed compute environments in the DISABLED state don't scale out.

Compute environments in a DISABLED state may continue to incur billing charges. To prevent additional charges, turn off and then delete the compute environment. For more information, see State in the Batch User Guide.

When an instance is idle, the instance scales down to the minvCpus value. However, the instance size doesn't change. For example, consider a c5.8xlarge instance with a minvCpus value of 4 and a desiredvCpus value of 36. This instance doesn't scale down to a c5.large instance.

iv_unmanagedvcpus TYPE /AWS1/BTCINTEGER /AWS1/BTCINTEGER

The maximum number of vCPUs expected to be used for an unmanaged compute environment. Don't specify this parameter for a managed compute environment. This parameter is only used for fair-share scheduling to reserve vCPU capacity for new share identifiers. If this parameter isn't provided for a fair-share job queue, no vCPU capacity is reserved.

io_computeresources TYPE REF TO /AWS1/CL_BTCCOMPUTERESRCUPDATE /AWS1/CL_BTCCOMPUTERESRCUPDATE

Details of the compute resources managed by the compute environment. Required for a managed compute environment. For more information, see Compute Environments in the Batch User Guide.

iv_servicerole TYPE /AWS1/BTCSTRING /AWS1/BTCSTRING

The full Amazon Resource Name (ARN) of the IAM role that allows Batch to make calls to other Amazon Web Services services on your behalf. For more information, see Batch service IAM role in the Batch User Guide.

If the compute environment has a service-linked role, it can't be changed to use a regular IAM role. Likewise, if the compute environment has a regular IAM role, it can't be changed to use a service-linked role. To update the parameters for the compute environment that require an infrastructure update to change, the AWSServiceRoleForBatch service-linked role must be used. For more information, see Updating compute environments in the Batch User Guide.

If your specified role has a path other than /, then you must either specify the full role ARN (recommended) or prefix the role name with the path.

Depending on how you created your Batch service role, its ARN might contain the service-role path prefix. When you only specify the name of the service role, Batch assumes that your ARN doesn't use the service-role path prefix. Because of this, we recommend that you specify the full ARN of your service role when you create compute environments.

io_updatepolicy TYPE REF TO /AWS1/CL_BTCUPDATEPOLICY /AWS1/CL_BTCUPDATEPOLICY

Specifies the updated infrastructure update policy for the compute environment. For more information about infrastructure updates, see Updating compute environments in the Batch User Guide.

iv_context TYPE /AWS1/BTCSTRING /AWS1/BTCSTRING

Reserved.

RETURNING

oo_output TYPE REF TO /aws1/cl_btcupcomputeenviron01 /AWS1/CL_BTCUPCOMPUTEENVIRON01

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->updatecomputeenvironment(
  io_computeresources = new /aws1/cl_btccomputeresrcupdate(
    io_launchtemplate = new /aws1/cl_btclaunchtemplatespec(
      it_overrides = VALUE /aws1/cl_btclaunchtmplspecov00=>tt_launchtmplspecoverridelist(
        (
          new /aws1/cl_btclaunchtmplspecov00(
            it_targetinstancetypes = VALUE /aws1/cl_btcstringlist_w=>tt_stringlist(
              ( new /aws1/cl_btcstringlist_w( |string| ) )
            )
            iv_launchtemplateid = |string|
            iv_launchtemplatename = |string|
            iv_userdatatype = |string|
            iv_version = |string|
          )
        )
      )
      iv_launchtemplateid = |string|
      iv_launchtemplatename = |string|
      iv_userdatatype = |string|
      iv_version = |string|
    )
    it_ec2configuration = VALUE /aws1/cl_btcec2configuration=>tt_ec2configurationlist(
      (
        new /aws1/cl_btcec2configuration(
          iv_imageidoverride = |string|
          iv_imagekubernetesversion = |string|
          iv_imagetype = |string|
        )
      )
    )
    it_instancetypes = VALUE /aws1/cl_btcstringlist_w=>tt_stringlist(
      ( new /aws1/cl_btcstringlist_w( |string| ) )
    )
    it_securitygroupids = VALUE /aws1/cl_btcstringlist_w=>tt_stringlist(
      ( new /aws1/cl_btcstringlist_w( |string| ) )
    )
    it_subnets = VALUE /aws1/cl_btcstringlist_w=>tt_stringlist(
      ( new /aws1/cl_btcstringlist_w( |string| ) )
    )
    it_tags = VALUE /aws1/cl_btctagsmap_w=>tt_tagsmap(
      (
        VALUE /aws1/cl_btctagsmap_w=>ts_tagsmap_maprow(
          key = |string|
          value = new /aws1/cl_btctagsmap_w( |string| )
        )
      )
    )
    iv_allocationstrategy = |string|
    iv_bidpercentage = 123
    iv_desiredvcpus = 123
    iv_ec2keypair = |string|
    iv_imageid = |string|
    iv_instancerole = |string|
    iv_maxvcpus = 123
    iv_minvcpus = 123
    iv_placementgroup = |string|
    iv_type = |string|
    iv_updatetolatestimagevrs = ABAP_TRUE
  )
  io_updatepolicy = new /aws1/cl_btcupdatepolicy(
    iv_jobexectimeoutminutes = 123
    iv_terminatejobsonupdate = ABAP_TRUE
  )
  iv_computeenvironment = |string|
  iv_context = |string|
  iv_servicerole = |string|
  iv_state = |string|
  iv_unmanagedvcpus = 123
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_string = lo_result->get_computeenvironmentname( ).
  lv_string = lo_result->get_computeenvironmentarn( ).
ENDIF.

To update a compute environment

This example disables the P2OnDemand compute environment so it can be deleted.

DATA(lo_result) = lo_client->updatecomputeenvironment(
  iv_computeenvironment = |P2OnDemand|
  iv_state = |DISABLED|
).