DescribeClusterNode - Amazon SageMaker
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).


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.


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


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.


The details of the instance.

Type: ClusterNodeDetails object


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


Resource being access is not found.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: