Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeClusterNode

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

Request Syntax


{
   "ClusterName": "string",
   "NodeId": "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 instance is.

Type: String

Length Constraints: 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 instance.

Type: String

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

Pattern: ^[a-zA-Z][-a-zA-Z0-9]*$

Required: Yes

Response Syntax


{
   "NodeDetails": { 
      "InstanceGroupName": "string",
      "InstanceId": "string",
      "InstanceStatus": { 
         "Message": "string",
         "Status": "string"
      },
      "InstanceType": "string",
      "LaunchTime": number,
      "LifeCycleConfig": { 
         "OnCreate": "string",
         "SourceS3Uri": "string"
      },
      "ThreadsPerCore": number
   }
}

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 instance.

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