Skip to content

/AWS1/CL_BTCSERVICEENVDETAIL

Detailed information about a service environment, including its configuration, state, and capacity limits.

CONSTRUCTOR

IMPORTING

Required arguments:

iv_serviceenvironmentname TYPE /AWS1/BTCSTRING /AWS1/BTCSTRING

The name of the service environment.

iv_serviceenvironmentarn TYPE /AWS1/BTCSTRING /AWS1/BTCSTRING

The Amazon Resource Name (ARN) of the service environment.

iv_serviceenvironmenttype TYPE /AWS1/BTCSERVICEENVTYPE /AWS1/BTCSERVICEENVTYPE

The type of service environment. For SageMaker Training jobs, this value is SAGEMAKER_TRAINING.

it_capacitylimits TYPE /AWS1/CL_BTCCAPACITYLIMIT=>TT_CAPACITYLIMITS TT_CAPACITYLIMITS

The capacity limits for the service environment. This defines the maximum resources that can be used by service jobs in this environment.

Optional arguments:

iv_state TYPE /AWS1/BTCSERVICEENVSTATE /AWS1/BTCSERVICEENVSTATE

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

iv_status TYPE /AWS1/BTCSERVICEENVSTATUS /AWS1/BTCSERVICEENVSTATUS

The current status of the service environment.

it_tags TYPE /AWS1/CL_BTCTAGRISTAGSMAP_W=>TT_TAGRISTAGSMAP TT_TAGRISTAGSMAP

The tags associated with the service environment. Each tag consists of a key and an optional value. For more information, see Tagging your Batch resources.


Queryable Attributes

serviceEnvironmentName

The name of the service environment.

Accessible with the following methods

Method Description
GET_SERVICEENVIRONMENTNAME() Getter for SERVICEENVIRONMENTNAME, with configurable default
ASK_SERVICEENVIRONMENTNAME() Getter for SERVICEENVIRONMENTNAME w/ exceptions if field has
HAS_SERVICEENVIRONMENTNAME() Determine if SERVICEENVIRONMENTNAME has a value

serviceEnvironmentArn

The Amazon Resource Name (ARN) of the service environment.

Accessible with the following methods

Method Description
GET_SERVICEENVIRONMENTARN() Getter for SERVICEENVIRONMENTARN, with configurable default
ASK_SERVICEENVIRONMENTARN() Getter for SERVICEENVIRONMENTARN w/ exceptions if field has
HAS_SERVICEENVIRONMENTARN() Determine if SERVICEENVIRONMENTARN has a value

serviceEnvironmentType

The type of service environment. For SageMaker Training jobs, this value is SAGEMAKER_TRAINING.

Accessible with the following methods

Method Description
GET_SERVICEENVIRONMENTTYPE() Getter for SERVICEENVIRONMENTTYPE, with configurable default
ASK_SERVICEENVIRONMENTTYPE() Getter for SERVICEENVIRONMENTTYPE w/ exceptions if field has
HAS_SERVICEENVIRONMENTTYPE() Determine if SERVICEENVIRONMENTTYPE has a value

state

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

Accessible with the following methods

Method Description
GET_STATE() Getter for STATE, with configurable default
ASK_STATE() Getter for STATE w/ exceptions if field has no value
HAS_STATE() Determine if STATE has a value

status

The current status of the service environment.

Accessible with the following methods

Method Description
GET_STATUS() Getter for STATUS, with configurable default
ASK_STATUS() Getter for STATUS w/ exceptions if field has no value
HAS_STATUS() Determine if STATUS has a value

capacityLimits

The capacity limits for the service environment. This defines the maximum resources that can be used by service jobs in this environment.

Accessible with the following methods

Method Description
GET_CAPACITYLIMITS() Getter for CAPACITYLIMITS, with configurable default
ASK_CAPACITYLIMITS() Getter for CAPACITYLIMITS w/ exceptions if field has no valu
HAS_CAPACITYLIMITS() Determine if CAPACITYLIMITS has a value

tags

The tags associated with the service environment. Each tag consists of a key and an optional value. For more information, see Tagging your Batch resources.

Accessible with the following methods

Method Description
GET_TAGS() Getter for TAGS, with configurable default
ASK_TAGS() Getter for TAGS w/ exceptions if field has no value
HAS_TAGS() Determine if TAGS has a value

Public Local Types In This Class

Internal table types, representing arrays and maps of this class, are defined as local types:

TT_SERVICEENVDETAILLIST

TYPES TT_SERVICEENVDETAILLIST TYPE STANDARD TABLE OF REF TO /AWS1/CL_BTCSERVICEENVDETAIL WITH DEFAULT KEY
.