Deletes specific nodes within a SageMaker HyperPod cluster¶

Description¶

Deletes specific nodes within a SageMaker HyperPod cluster. batch_delete_cluster_nodes accepts a cluster name and a list of node IDs.

• To safeguard your work, back up your data to Amazon S3 or an FSx for Lustre file system before invoking the API on a worker node group. This will help prevent any potential data loss from the instance root volume. For more information about backup, see Use the backup script provided by SageMaker HyperPod.
• If you want to invoke this API on an existing cluster, you'll first need to patch the cluster by running the UpdateClusterSoftware API. For more information about patching a cluster, see Update the SageMaker HyperPod platform software of a cluster.

Usage¶

sagemaker_batch_delete_cluster_nodes(ClusterName, NodeIds,
  NodeLogicalIds)

Arguments¶

• ClusterName

  [required] The name of the SageMaker HyperPod cluster from which to delete the specified nodes.

• NodeIds

  A list of node IDs to be deleted from the specified cluster.

  • For SageMaker HyperPod clusters using the Slurm workload manager, you cannot remove instances that are configured as Slurm controller nodes.
  • If you need to delete more than 99 instances, contact Support for assistance.

• NodeLogicalIds

  A list of NodeLogicalIds identifying the nodes to be deleted. You can specify up to 50 NodeLogicalIds. You must specify either NodeLogicalIds, InstanceIds, or both, with a combined maximum of 50 identifiers.

Value¶

A list with the following syntax:

list(
  Failed = list(
    list(
      Code = "NodeIdNotFound"|"InvalidNodeStatus"|"NodeIdInUse",
      Message = "string",
      NodeId = "string"
    )
  ),
  Successful = list(
    "string"
  ),
  FailedNodeLogicalIds = list(
    list(
      Code = "NodeIdNotFound"|"InvalidNodeStatus"|"NodeIdInUse",
      Message = "string",
      NodeLogicalId = "string"
    )
  ),
  SuccessfulNodeLogicalIds = list(
    "string"
  )
)

Request syntax¶

svc$batch_delete_cluster_nodes(
  ClusterName = "string",
  NodeIds = list(
    "string"
  ),
  NodeLogicalIds = list(
    "string"
  )
)