describe_cluster_node ¶

def describe_cluster_node(
    self,
    *,
    config_overrides: Optional[SageMakerClientConfig] = None,
    cluster_name: Optional[
        "capo_sagemaker.types.cluster_name_or_arn.ClusterNameOrArn"
    ] = None,
    node_id: Optional["capo_sagemaker.types.cluster_node_id.ClusterNodeId"] = None,
    node_logical_id: Optional[
        "capo_sagemaker.types.cluster_node_logical_id.ClusterNodeLogicalId"
    ] = None,
) -> "capo_sagemaker.types.describe_cluster_node_response.DescribeClusterNodeResponse":
    """<p>Retrieves information of a node (also called a <i>instance</i> interchangeably) of a SageMaker HyperPod cluster.</p>

    Args:
        cluster_name: <p>The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster in which the node is.</p>
        node_id: <p>The ID of the SageMaker HyperPod cluster node.</p>
        node_logical_id: <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>

    Raises:
        capo_sagemaker.errors.resource_not_found.ResourceNotFound: <p>Resource being access is not found.</p>
        capo_sagemaker.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_sagemaker.types.describe_cluster_node_request.DescribeClusterNodeRequest]",
    ) -> OperationResponse[
        "capo_sagemaker.types.describe_cluster_node_response.DescribeClusterNodeResponse"
    ]:
        import capo_sagemaker._operations.sage_maker.describe_cluster_node

        output, http_response = (
            capo_sagemaker._operations.sage_maker.describe_cluster_node.describe_cluster_node(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeClusterNode")
    )
    input_: capo_sagemaker.types.describe_cluster_node_request.DescribeClusterNodeRequest = {}
    if cluster_name is not None:
        input_["cluster_name"] = cluster_name
    if node_id is not None:
        input_["node_id"] = node_id
    if node_logical_id is not None:
        input_["node_logical_id"] = node_logical_id

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output