2024/06/04 - Amazon SageMaker Service - 1 updated api methods
Changes Extend DescribeClusterNode response with private DNS hostname and IP address, and placement information about availability zone and availability zone ID.
{'NodeDetails': {'Placement': {'AvailabilityZone': 'string', 'AvailabilityZoneId': 'string'}, 'PrivateDnsHostname': 'string', 'PrivatePrimaryIp': 'string'}}
Retrieves information of a node (also called a instance interchangeably) of a SageMaker HyperPod cluster.
See also: AWS API Documentation
Request Syntax
client.describe_cluster_node( ClusterName='string', NodeId='string' )
string
[REQUIRED]
The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster in which the node is.
string
[REQUIRED]
The ID of the SageMaker HyperPod cluster node.
dict
Response Syntax
{ 'NodeDetails': { 'InstanceGroupName': 'string', 'InstanceId': 'string', 'InstanceStatus': { 'Status': 'Running'|'Failure'|'Pending'|'ShuttingDown'|'SystemUpdating', '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', 'LaunchTime': datetime(2015, 1, 1), 'LifeCycleConfig': { 'SourceS3Uri': 'string', 'OnCreate': 'string' }, 'ThreadsPerCore': 123, 'PrivatePrimaryIp': 'string', 'PrivateDnsHostname': 'string', 'Placement': { 'AvailabilityZone': 'string', 'AvailabilityZoneId': 'string' } } }
Response Structure
(dict) --
NodeDetails (dict) --
The details of the SageMaker HyperPod cluster node.
InstanceGroupName (string) --
The instance group name in which the instance is.
InstanceId (string) --
The ID of the instance.
InstanceStatus (dict) --
The status of the instance.
Status (string) --
The status of an instance in a SageMaker HyperPod cluster.
Message (string) --
The message from an instance in a SageMaker HyperPod cluster.
InstanceType (string) --
The type of the instance.
LaunchTime (datetime) --
The time when the instance is launched.
LifeCycleConfig (dict) --
The LifeCycle configuration applied to the instance.
SourceS3Uri (string) --
An Amazon S3 bucket path where your lifecycle scripts are stored.
Warning
Make sure that the S3 bucket path starts with s3://sagemaker- . The IAM role for SageMaker HyperPod has the managed AmazonSageMakerClusterInstanceRolePolicy attached, which allows access to S3 buckets with the specific prefix sagemaker- .
OnCreate (string) --
The file name of the entrypoint script of lifecycle scripts under SourceS3Uri . This entrypoint script runs during cluster creation.
ThreadsPerCore (integer) --
The number of threads per CPU core you specified under CreateCluster .
PrivatePrimaryIp (string) --
The private primary IP address of the SageMaker HyperPod cluster node.
PrivateDnsHostname (string) --
The private DNS hostname of the SageMaker HyperPod cluster node.
Placement (dict) --
The placement details of the SageMaker HyperPod cluster node.
AvailabilityZone (string) --
The Availability Zone where the node in the SageMaker HyperPod cluster is launched.
AvailabilityZoneId (string) --
The unique identifier (ID) of the Availability Zone where the node in the SageMaker HyperPod cluster is launched.