Describe Cluster Node

sagemaker_describe_cluster_node

R Documentation

Retrieves information of a node (also called a instance interchangeably) of a SageMaker HyperPod cluster

Description

Retrieves information of a node (also called a instance interchangeably) of a SageMaker HyperPod cluster.

Usage

sagemaker_describe_cluster_node(ClusterName, NodeId)

Arguments

ClusterName

[required] The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster in which the node is.

NodeId

[required] The ID of the SageMaker HyperPod cluster node.

Value

A list with the following syntax:

list(
  NodeDetails = list(
    InstanceGroupName = "string",
    InstanceId = "string",
    InstanceStatus = list(
      Status = "Running"|"Failure"|"Pending"|"ShuttingDown"|"SystemUpdating"|"DeepHealthCheckInProgress",
      Message = "string"
    ),
    InstanceType = "ml.p4d.24xlarge"|"ml.p4de.24xlarge"|"ml.p5.48xlarge"|"ml.trn1.32xlarge"|"ml.trn1n.32xlarge"|"ml.g5.xlarge"|"ml.g5.2xlarge"|"ml.g5.4xlarge"|"ml.g5.8xlarge"|"ml.g5.12xlarge"|"ml.g5.16xlarge"|"ml.g5.24xlarge"|"ml.g5.48xlarge"|"ml.c5.large"|"ml.c5.xlarge"|"ml.c5.2xlarge"|"ml.c5.4xlarge"|"ml.c5.9xlarge"|"ml.c5.12xlarge"|"ml.c5.18xlarge"|"ml.c5.24xlarge"|"ml.c5n.large"|"ml.c5n.2xlarge"|"ml.c5n.4xlarge"|"ml.c5n.9xlarge"|"ml.c5n.18xlarge"|"ml.m5.large"|"ml.m5.xlarge"|"ml.m5.2xlarge"|"ml.m5.4xlarge"|"ml.m5.8xlarge"|"ml.m5.12xlarge"|"ml.m5.16xlarge"|"ml.m5.24xlarge"|"ml.t3.medium"|"ml.t3.large"|"ml.t3.xlarge"|"ml.t3.2xlarge"|"ml.g6.xlarge"|"ml.g6.2xlarge"|"ml.g6.4xlarge"|"ml.g6.8xlarge"|"ml.g6.16xlarge"|"ml.g6.12xlarge"|"ml.g6.24xlarge"|"ml.g6.48xlarge"|"ml.gr6.4xlarge"|"ml.gr6.8xlarge"|"ml.g6e.xlarge"|"ml.g6e.2xlarge"|"ml.g6e.4xlarge"|"ml.g6e.8xlarge"|"ml.g6e.16xlarge"|"ml.g6e.12xlarge"|"ml.g6e.24xlarge"|"ml.g6e.48xlarge"|"ml.p5e.48xlarge"|"ml.p5en.48xlarge"|"ml.trn2.48xlarge"|"ml.c6i.large"|"ml.c6i.xlarge"|"ml.c6i.2xlarge"|"ml.c6i.4xlarge"|"ml.c6i.8xlarge"|"ml.c6i.12xlarge"|"ml.c6i.16xlarge"|"ml.c6i.24xlarge"|"ml.c6i.32xlarge"|"ml.m6i.large"|"ml.m6i.xlarge"|"ml.m6i.2xlarge"|"ml.m6i.4xlarge"|"ml.m6i.8xlarge"|"ml.m6i.12xlarge"|"ml.m6i.16xlarge"|"ml.m6i.24xlarge"|"ml.m6i.32xlarge"|"ml.r6i.large"|"ml.r6i.xlarge"|"ml.r6i.2xlarge"|"ml.r6i.4xlarge"|"ml.r6i.8xlarge"|"ml.r6i.12xlarge"|"ml.r6i.16xlarge"|"ml.r6i.24xlarge"|"ml.r6i.32xlarge",
    LaunchTime = as.POSIXct(
      "2015-01-01"
    ),
    LifeCycleConfig = list(
      SourceS3Uri = "string",
      OnCreate = "string"
    ),
    OverrideVpcConfig = list(
      SecurityGroupIds = list(
        "string"
      ),
      Subnets = list(
        "string"
      )
    ),
    ThreadsPerCore = 123,
    InstanceStorageConfigs = list(
      list(
        EbsVolumeConfig = list(
          VolumeSizeInGB = 123
        )
      )
    ),
    PrivatePrimaryIp = "string",
    PrivatePrimaryIpv6 = "string",
    PrivateDnsHostname = "string",
    Placement = list(
      AvailabilityZone = "string",
      AvailabilityZoneId = "string"
    )
  )
)

Request syntax

svc$describe_cluster_node(
  ClusterName = "string",
  NodeId = "string"
)