Skip to content

DescribeClusterNodeRequest

Source code in docs_src/capo_sagemaker/types/describe_cluster_node_request.py 
13
14
15
16
17
18
19
20
21
22
23
class DescribeClusterNodeRequest(TypedDict, closed=True):
    cluster_name: NotRequired[
        "capo_sagemaker.types.cluster_name_or_arn.ClusterNameOrArn"
    ]
    """<p>The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster in which the node is.</p>"""
    node_id: NotRequired["capo_sagemaker.types.cluster_node_id.ClusterNodeId"]
    """<p>The ID of the SageMaker HyperPod cluster node.</p>"""
    node_logical_id: NotRequired[
        "capo_sagemaker.types.cluster_node_logical_id.ClusterNodeLogicalId"
    ]
    """<p>The logical identifier of the node to describe. You can specify either <code>NodeLogicalId</code> or <code>InstanceId</code>, but not both. <code>NodeLogicalId</code> can be used to describe nodes that are still being provisioned and don't yet have an <code>InstanceId</code> assigned.</p>"""

cluster_name instance-attribute 

cluster_name: NotRequired[ClusterNameOrArn]

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

node_id instance-attribute 

node_id: NotRequired[ClusterNodeId]

The ID of the SageMaker HyperPod cluster node.

node_logical_id instance-attribute 

node_logical_id: NotRequired[ClusterNodeLogicalId]

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.