Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeClusterNode

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

Request Syntax


{
   "ClusterName": "string",
   "NodeId": "string",
   "NodeLogicalId": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

ClusterName

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

Type: String

Length Constraints: Minimum length of 0. Maximum length of 256.

Pattern: (arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:cluster/[a-z0-9]{12})|([a-zA-Z0-9](-*[a-zA-Z0-9]){0,62})

Required: Yes

NodeId

The ID of the SageMaker HyperPod cluster node.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: i-[a-f0-9]{8}(?:[a-f0-9]{9})?

Required: No

NodeLogicalId

The logical identifier of the node to describe. You can specify either NodeLogicalId or InstanceId, but not both. NodeLogicalId can be used to describe nodes that are still being provisioned and don't yet have an InstanceId assigned.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9]

Required: No

Response Syntax


{
   "NodeDetails": { 
      "CurrentImageId": "string",
      "DesiredImageId": "string",
      "InstanceGroupName": "string",
      "InstanceId": "string",
      "InstanceStatus": { 
         "Message": "string",
         "Status": "string"
      },
      "InstanceStorageConfigs": [ 
         { ... }
      ],
      "InstanceType": "string",
      "LastSoftwareUpdateTime": number,
      "LaunchTime": number,
      "LifeCycleConfig": { 
         "OnCreate": "string",
         "SourceS3Uri": "string"
      },
      "NodeLogicalId": "string",
      "OverrideVpcConfig": { 
         "SecurityGroupIds": [ "string" ],
         "Subnets": [ "string" ]
      },
      "Placement": { 
         "AvailabilityZone": "string",
         "AvailabilityZoneId": "string"
      },
      "PrivateDnsHostname": "string",
      "PrivatePrimaryIp": "string",
      "PrivatePrimaryIpv6": "string",
      "ThreadsPerCore": number,
      "UltraServerInfo": { 
         "Id": "string"
      }
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NodeDetails

The details of the SageMaker HyperPod cluster node.

Type: ClusterNodeDetails object

Errors

For information about the errors that are common to all actions, see Common Errors.

ResourceNotFound

Resource being access is not found.

HTTP Status Code: 400