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/async_sage_maker.py
| async def describe_cluster(
self,
*,
config_overrides: Optional[AsyncSageMakerClientConfig] = 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.
"""
async def _handler(
req: "AsyncOperationRequest[capo_sagemaker.types.describe_cluster_request.DescribeClusterRequest]",
) -> AsyncOperationResponse[
"capo_sagemaker.types.describe_cluster_response.DescribeClusterResponse"
]:
import capo_sagemaker._operations.sage_maker.describe_cluster
(
output,
http_response,
) = await capo_sagemaker._operations.sage_maker.describe_cluster.async_describe_cluster(
req.options, req.input
)
return AsyncOperationResponse(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 = await aexecute_pipeline(
AsyncOperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
await response.response.aclose()
return response.output
|