Skip to content

/AWS1/CL_SGMDESCRCLUSTERRSP

DescribeClusterResponse

CONSTRUCTOR

IMPORTING

Required arguments:

iv_clusterarn TYPE /AWS1/SGMCLUSTERARN /AWS1/SGMCLUSTERARN

The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster.

iv_clusterstatus TYPE /AWS1/SGMCLUSTERSTATUS /AWS1/SGMCLUSTERSTATUS

The status of the SageMaker HyperPod cluster.

it_instancegroups TYPE /AWS1/CL_SGMCLUSTINSTGROUPDETS=>TT_CLUSTERINSTGROUPDETAILSLIST TT_CLUSTERINSTGROUPDETAILSLIST

The instance groups of the SageMaker HyperPod cluster.

Optional arguments:

iv_clustername TYPE /AWS1/SGMCLUSTERNAME /AWS1/SGMCLUSTERNAME

The name of the SageMaker HyperPod cluster.

iv_creationtime TYPE /AWS1/SGMTIMESTAMP /AWS1/SGMTIMESTAMP

The time when the SageMaker Cluster is created.

iv_failuremessage TYPE /AWS1/SGMSTRING /AWS1/SGMSTRING

The failure message of the SageMaker HyperPod cluster.

it_restrictedinstancegroups TYPE /AWS1/CL_SGMCLSTRESTRICTEDIN01=>TT_CLSTRESTRICTEDINSTGRDETSLST TT_CLSTRESTRICTEDINSTGRDETSLST

The specialized instance groups for training models like Amazon Nova to be created in the SageMaker HyperPod cluster.

io_vpcconfig TYPE REF TO /AWS1/CL_SGMVPCCONFIG /AWS1/CL_SGMVPCCONFIG

VpcConfig

io_orchestrator TYPE REF TO /AWS1/CL_SGMCLUSTORCHESTRATOR /AWS1/CL_SGMCLUSTORCHESTRATOR

The type of orchestrator used for the SageMaker HyperPod cluster.

io_tieredstorageconfig TYPE REF TO /AWS1/CL_SGMCLUSTTIEREDSTRGCFG /AWS1/CL_SGMCLUSTTIEREDSTRGCFG

The current configuration for managed tier checkpointing on the HyperPod cluster. For example, this shows whether the feature is enabled and the percentage of cluster memory allocated for checkpoint storage.

iv_noderecovery TYPE /AWS1/SGMCLUSTERNODERECOVERY /AWS1/SGMCLUSTERNODERECOVERY

The node recovery mode configured for the SageMaker HyperPod cluster.

iv_nodeprovisioningmode TYPE /AWS1/SGMCLUSTERNODEPROVMODE /AWS1/SGMCLUSTERNODEPROVMODE

The mode used for provisioning nodes in the cluster.

iv_clusterrole TYPE /AWS1/SGMROLEARN /AWS1/SGMROLEARN

The Amazon Resource Name (ARN) of the IAM role that HyperPod uses for cluster autoscaling operations.

io_autoscaling TYPE REF TO /AWS1/CL_SGMCLUSTAUTOSCCFGOUT /AWS1/CL_SGMCLUSTAUTOSCCFGOUT

The current autoscaling configuration and status for the autoscaler.


Queryable Attributes

ClusterArn

The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster.

Accessible with the following methods

Method Description
GET_CLUSTERARN() Getter for CLUSTERARN, with configurable default
ASK_CLUSTERARN() Getter for CLUSTERARN w/ exceptions if field has no value
HAS_CLUSTERARN() Determine if CLUSTERARN has a value

ClusterName

The name of the SageMaker HyperPod cluster.

Accessible with the following methods

Method Description
GET_CLUSTERNAME() Getter for CLUSTERNAME, with configurable default
ASK_CLUSTERNAME() Getter for CLUSTERNAME w/ exceptions if field has no value
HAS_CLUSTERNAME() Determine if CLUSTERNAME has a value

ClusterStatus

The status of the SageMaker HyperPod cluster.

Accessible with the following methods

Method Description
GET_CLUSTERSTATUS() Getter for CLUSTERSTATUS, with configurable default
ASK_CLUSTERSTATUS() Getter for CLUSTERSTATUS w/ exceptions if field has no value
HAS_CLUSTERSTATUS() Determine if CLUSTERSTATUS has a value

CreationTime

The time when the SageMaker Cluster is created.

Accessible with the following methods

Method Description
GET_CREATIONTIME() Getter for CREATIONTIME, with configurable default
ASK_CREATIONTIME() Getter for CREATIONTIME w/ exceptions if field has no value
HAS_CREATIONTIME() Determine if CREATIONTIME has a value

FailureMessage

The failure message of the SageMaker HyperPod cluster.

Accessible with the following methods

Method Description
GET_FAILUREMESSAGE() Getter for FAILUREMESSAGE, with configurable default
ASK_FAILUREMESSAGE() Getter for FAILUREMESSAGE w/ exceptions if field has no valu
HAS_FAILUREMESSAGE() Determine if FAILUREMESSAGE has a value

InstanceGroups

The instance groups of the SageMaker HyperPod cluster.

Accessible with the following methods

Method Description
GET_INSTANCEGROUPS() Getter for INSTANCEGROUPS, with configurable default
ASK_INSTANCEGROUPS() Getter for INSTANCEGROUPS w/ exceptions if field has no valu
HAS_INSTANCEGROUPS() Determine if INSTANCEGROUPS has a value

RestrictedInstanceGroups

The specialized instance groups for training models like Amazon Nova to be created in the SageMaker HyperPod cluster.

Accessible with the following methods

Method Description
GET_RESTRICTEDINSTANCEGROUPS() Getter for RESTRICTEDINSTANCEGROUPS, with configurable defau
ASK_RESTRICTEDINSTANCEGROUPS() Getter for RESTRICTEDINSTANCEGROUPS w/ exceptions if field h
HAS_RESTRICTEDINSTANCEGROUPS() Determine if RESTRICTEDINSTANCEGROUPS has a value

VpcConfig

VpcConfig

Accessible with the following methods

Method Description
GET_VPCCONFIG() Getter for VPCCONFIG

Orchestrator

The type of orchestrator used for the SageMaker HyperPod cluster.

Accessible with the following methods

Method Description
GET_ORCHESTRATOR() Getter for ORCHESTRATOR

TieredStorageConfig

The current configuration for managed tier checkpointing on the HyperPod cluster. For example, this shows whether the feature is enabled and the percentage of cluster memory allocated for checkpoint storage.

Accessible with the following methods

Method Description
GET_TIEREDSTORAGECONFIG() Getter for TIEREDSTORAGECONFIG

NodeRecovery

The node recovery mode configured for the SageMaker HyperPod cluster.

Accessible with the following methods

Method Description
GET_NODERECOVERY() Getter for NODERECOVERY, with configurable default
ASK_NODERECOVERY() Getter for NODERECOVERY w/ exceptions if field has no value
HAS_NODERECOVERY() Determine if NODERECOVERY has a value

NodeProvisioningMode

The mode used for provisioning nodes in the cluster.

Accessible with the following methods

Method Description
GET_NODEPROVISIONINGMODE() Getter for NODEPROVISIONINGMODE, with configurable default
ASK_NODEPROVISIONINGMODE() Getter for NODEPROVISIONINGMODE w/ exceptions if field has n
HAS_NODEPROVISIONINGMODE() Determine if NODEPROVISIONINGMODE has a value

ClusterRole

The Amazon Resource Name (ARN) of the IAM role that HyperPod uses for cluster autoscaling operations.

Accessible with the following methods

Method Description
GET_CLUSTERROLE() Getter for CLUSTERROLE, with configurable default
ASK_CLUSTERROLE() Getter for CLUSTERROLE w/ exceptions if field has no value
HAS_CLUSTERROLE() Determine if CLUSTERROLE has a value

AutoScaling

The current autoscaling configuration and status for the autoscaler.

Accessible with the following methods

Method Description
GET_AUTOSCALING() Getter for AUTOSCALING