Skip to content

describe_cluster

describe_cluster(
    *,
    config_overrides: Optional[SageMakerClientConfig] = None,
    cluster_name: Optional[ClusterNameOrArn] = None,
) -> DescribeClusterResponse

Retrieves information of a SageMaker HyperPod cluster.

Parameters:

  • cluster_name (Optional[ClusterNameOrArn], default: None ) –

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

Raises:

Source code in docs_src/capo_sagemaker/_services/sage_maker.py
def describe_cluster(
    self,
    *,
    config_overrides: Optional[SageMakerClientConfig] = None,
    cluster_name: Optional[
        "capo_sagemaker.types.cluster_name_or_arn.ClusterNameOrArn"
    ] = None,
) -> "capo_sagemaker.types.describe_cluster_response.DescribeClusterResponse":
    """<p>Retrieves information of a SageMaker HyperPod cluster.</p>

    Args:
        cluster_name: <p>The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster.</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_request.DescribeClusterRequest]",
    ) -> OperationResponse[
        "capo_sagemaker.types.describe_cluster_response.DescribeClusterResponse"
    ]:
        import capo_sagemaker._operations.sage_maker.describe_cluster

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeCluster")
    )
    input_: capo_sagemaker.types.describe_cluster_request.DescribeClusterRequest = {}
    if cluster_name is not None:
        input_["cluster_name"] = cluster_name

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