Skip to content

/AWS1/IF_BTC=>CREATESERVICEENVIRONMENT()

About CreateServiceEnvironment

Creates a service environment for running service jobs. Service environments define capacity limits for specific service types such as SageMaker Training jobs.

Method Signature

METHODS /AWS1/IF_BTC~CREATESERVICEENVIRONMENT
  IMPORTING
    !IV_SERVICEENVIRONMENTNAME TYPE /AWS1/BTCSTRING OPTIONAL
    !IV_SERVICEENVIRONMENTTYPE TYPE /AWS1/BTCSERVICEENVTYPE OPTIONAL
    !IV_STATE TYPE /AWS1/BTCSERVICEENVSTATE OPTIONAL
    !IT_CAPACITYLIMITS TYPE /AWS1/CL_BTCCAPACITYLIMIT=>TT_CAPACITYLIMITS OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_BTCTAGRISTAGSMAP_W=>TT_TAGRISTAGSMAP OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_btccreatesvcenvrsp
  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_serviceenvironmentname TYPE /AWS1/BTCSTRING /AWS1/BTCSTRING

The name for the service environment. It can be up to 128 characters long and can contain letters, numbers, hyphens (-), and underscores (_).

iv_serviceenvironmenttype TYPE /AWS1/BTCSERVICEENVTYPE /AWS1/BTCSERVICEENVTYPE

The type of service environment. For SageMaker Training jobs, specify SAGEMAKER_TRAINING.

it_capacitylimits TYPE /AWS1/CL_BTCCAPACITYLIMIT=>TT_CAPACITYLIMITS TT_CAPACITYLIMITS

The capacity limits for the service environment. The number of instances a job consumes is the total number of instances requested in the submit training job request resource configuration.

Optional arguments:

iv_state TYPE /AWS1/BTCSERVICEENVSTATE /AWS1/BTCSERVICEENVSTATE

The state of the service environment. Valid values are ENABLED and DISABLED. The default value is ENABLED.

it_tags TYPE /AWS1/CL_BTCTAGRISTAGSMAP_W=>TT_TAGRISTAGSMAP TT_TAGRISTAGSMAP

The tags that you apply to the service environment to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging your Batch resources.

RETURNING

oo_output TYPE REF TO /aws1/cl_btccreatesvcenvrsp /AWS1/CL_BTCCREATESVCENVRSP

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->createserviceenvironment(
  it_capacitylimits = VALUE /aws1/cl_btccapacitylimit=>tt_capacitylimits(
    (
      new /aws1/cl_btccapacitylimit(
        iv_capacityunit = |string|
        iv_maxcapacity = 123
      )
    )
  )
  it_tags = VALUE /aws1/cl_btctagristagsmap_w=>tt_tagristagsmap(
    (
      VALUE /aws1/cl_btctagristagsmap_w=>ts_tagristagsmap_maprow(
        value = new /aws1/cl_btctagristagsmap_w( |string| )
        key = |string|
      )
    )
  )
  iv_serviceenvironmentname = |string|
  iv_serviceenvironmenttype = |string|
  iv_state = |string|
).

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_serviceenvironmentname( ).
  lv_string = lo_result->get_serviceenvironmentarn( ).
ENDIF.