Skip to content

/AWS1/CL_SGMCLUSTERNODESUMMARY

Lists a summary of the properties of an instance (also called a node interchangeably) of a SageMaker HyperPod cluster.

CONSTRUCTOR

IMPORTING

Required arguments:

iv_instancegroupname TYPE /AWS1/SGMCLUSTERINSTGROUPNAME /AWS1/SGMCLUSTERINSTGROUPNAME

The name of the instance group in which the instance is.

iv_instanceid TYPE /AWS1/SGMSTRING00 /AWS1/SGMSTRING00

The ID of the instance.

iv_instancetype TYPE /AWS1/SGMCLUSTERINSTANCETYPE /AWS1/SGMCLUSTERINSTANCETYPE

The type of the instance.

iv_launchtime TYPE /AWS1/SGMTIMESTAMP /AWS1/SGMTIMESTAMP

The time when the instance is launched.

io_instancestatus TYPE REF TO /AWS1/CL_SGMCLUSTINSTSTATDETS /AWS1/CL_SGMCLUSTINSTSTATDETS

The status of the instance.

Optional arguments:

iv_nodelogicalid TYPE /AWS1/SGMSTRING00 /AWS1/SGMSTRING00

A unique identifier for the node that persists throughout its lifecycle, from provisioning request to termination. This identifier can be used to track the node even before it has an assigned InstanceId. This field is only included when IncludeNodeLogicalIds is set to True in the ListClusterNodes request.

iv_lastsoftwareupdatetime TYPE /AWS1/SGMTIMESTAMP /AWS1/SGMTIMESTAMP

The time when SageMaker last updated the software of the instances in the cluster.

io_ultraserverinfo TYPE REF TO /AWS1/CL_SGMULTRASERVERINFO /AWS1/CL_SGMULTRASERVERINFO

Contains information about the UltraServer.


Queryable Attributes

InstanceGroupName

The name of the instance group in which the instance is.

Accessible with the following methods

Method Description
GET_INSTANCEGROUPNAME() Getter for INSTANCEGROUPNAME, with configurable default
ASK_INSTANCEGROUPNAME() Getter for INSTANCEGROUPNAME w/ exceptions if field has no v
HAS_INSTANCEGROUPNAME() Determine if INSTANCEGROUPNAME has a value

InstanceId

The ID of the instance.

Accessible with the following methods

Method Description
GET_INSTANCEID() Getter for INSTANCEID, with configurable default
ASK_INSTANCEID() Getter for INSTANCEID w/ exceptions if field has no value
HAS_INSTANCEID() Determine if INSTANCEID has a value

NodeLogicalId

A unique identifier for the node that persists throughout its lifecycle, from provisioning request to termination. This identifier can be used to track the node even before it has an assigned InstanceId. This field is only included when IncludeNodeLogicalIds is set to True in the ListClusterNodes request.

Accessible with the following methods

Method Description
GET_NODELOGICALID() Getter for NODELOGICALID, with configurable default
ASK_NODELOGICALID() Getter for NODELOGICALID w/ exceptions if field has no value
HAS_NODELOGICALID() Determine if NODELOGICALID has a value

InstanceType

The type of the instance.

Accessible with the following methods

Method Description
GET_INSTANCETYPE() Getter for INSTANCETYPE, with configurable default
ASK_INSTANCETYPE() Getter for INSTANCETYPE w/ exceptions if field has no value
HAS_INSTANCETYPE() Determine if INSTANCETYPE has a value

LaunchTime

The time when the instance is launched.

Accessible with the following methods

Method Description
GET_LAUNCHTIME() Getter for LAUNCHTIME, with configurable default
ASK_LAUNCHTIME() Getter for LAUNCHTIME w/ exceptions if field has no value
HAS_LAUNCHTIME() Determine if LAUNCHTIME has a value

LastSoftwareUpdateTime

The time when SageMaker last updated the software of the instances in the cluster.

Accessible with the following methods

Method Description
GET_LASTSOFTWAREUPDATETIME() Getter for LASTSOFTWAREUPDATETIME, with configurable default
ASK_LASTSOFTWAREUPDATETIME() Getter for LASTSOFTWAREUPDATETIME w/ exceptions if field has
HAS_LASTSOFTWAREUPDATETIME() Determine if LASTSOFTWAREUPDATETIME has a value

InstanceStatus

The status of the instance.

Accessible with the following methods

Method Description
GET_INSTANCESTATUS() Getter for INSTANCESTATUS

UltraServerInfo

Contains information about the UltraServer.

Accessible with the following methods

Method Description
GET_ULTRASERVERINFO() Getter for ULTRASERVERINFO

Public Local Types In This Class

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

TT_CLUSTERNODESUMMARIES

TYPES TT_CLUSTERNODESUMMARIES TYPE STANDARD TABLE OF REF TO /AWS1/CL_SGMCLUSTERNODESUMMARY WITH DEFAULT KEY
.