Skip to content

ClusterNodeSummary

Source code in docs_src/capo_sagemaker/types/cluster_node_summary.py
class ClusterNodeSummary(TypedDict, closed=True):
    instance_group_name: NotRequired[
        "capo_sagemaker.types.cluster_instance_group_name.ClusterInstanceGroupName"
    ]
    """<p>The name of the instance group in which the instance is.</p>"""
    instance_id: NotRequired["str"]
    """<p>The ID of the instance.</p>"""
    node_logical_id: NotRequired["str"]
    """<p>A unique identifier for the node that persists throughout its lifecycle, from provisioning request to termination. This identifier can be used to track the node even before it has an assigned <code>InstanceId</code>. This field is only included when <code>IncludeNodeLogicalIds</code> is set to <code>True</code> in the <code>ListClusterNodes</code> request.</p>"""
    instance_type: NotRequired[
        "capo_sagemaker.types.cluster_instance_type.ClusterInstanceType"
    ]
    """<p>The type of the instance.</p>"""
    launch_time: NotRequired["capo_sagemaker.types.timestamp.Timestamp"]
    """<p>The time when the instance is launched.</p>"""
    last_software_update_time: NotRequired["capo_sagemaker.types.timestamp.Timestamp"]
    """<p>The time when SageMaker last updated the software of the instances in the cluster.</p>"""
    instance_status: NotRequired[
        "capo_sagemaker.types.cluster_instance_status_details.ClusterInstanceStatusDetails"
    ]
    """<p>The status of the instance.</p>"""
    ultra_server_info: NotRequired[
        "capo_sagemaker.types.ultra_server_info.UltraServerInfo"
    ]
    """<p>Contains information about the UltraServer.</p>"""
    private_dns_hostname: NotRequired[
        "capo_sagemaker.types.cluster_private_dns_hostname.ClusterPrivateDnsHostname"
    ]
    """<p>The private DNS hostname of the SageMaker HyperPod cluster node.</p>"""
    current_image_release_version: NotRequired[
        "capo_sagemaker.types.image_release_version.ImageReleaseVersion"
    ]
    """<p>The version of the HyperPod-managed AMI currently running on the node.</p>"""
    image_version_status: NotRequired[
        "capo_sagemaker.types.cluster_image_version_status.ClusterImageVersionStatus"
    ]
    """<p>The status of the image version for the cluster node.</p>"""

current_image_release_version instance-attribute

current_image_release_version: NotRequired[ImageReleaseVersion]

The version of the HyperPod-managed AMI currently running on the node.

image_version_status instance-attribute

image_version_status: NotRequired[ClusterImageVersionStatus]

The status of the image version for the cluster node.

instance_group_name instance-attribute

instance_group_name: NotRequired[ClusterInstanceGroupName]

The name of the instance group in which the instance is.

instance_id instance-attribute

instance_id: NotRequired[str]

The ID of the instance.

instance_status instance-attribute

instance_status: NotRequired[ClusterInstanceStatusDetails]

The status of the instance.

instance_type instance-attribute

instance_type: NotRequired[ClusterInstanceType]

The type of the instance.

last_software_update_time instance-attribute

last_software_update_time: NotRequired[Timestamp]

The time when SageMaker last updated the software of the instances in the cluster.

launch_time instance-attribute

launch_time: NotRequired[Timestamp]

The time when the instance is launched.

node_logical_id instance-attribute

node_logical_id: NotRequired[str]

A unique identifier for the node that persists throughout its lifecycle, from provisioning request to termination. This identifier can be used to track the node even before it has an assigned InstanceId. This field is only included when IncludeNodeLogicalIds is set to True in the ListClusterNodes request.

private_dns_hostname instance-attribute

private_dns_hostname: NotRequired[ClusterPrivateDnsHostname]

The private DNS hostname of the SageMaker HyperPod cluster node.

ultra_server_info instance-attribute

ultra_server_info: NotRequired[UltraServerInfo]

Contains information about the UltraServer.