Retrieves detailed information about a specific event for a given HyperPod cluster. This functionality is only supported when the NodeProvisioningMode is set to Continuous.
Parameters:
-
event_id
(Optional[EventId], default:
None
)
–
The unique identifier (UUID) of the event to describe. This ID can be obtained from the ListClusterEvents operation.
-
cluster_name
(Optional[ClusterNameOrArn], default:
None
)
–
The name or Amazon Resource Name (ARN) of the HyperPod cluster associated with the event.
Raises:
Source code in docs_src/capo_sagemaker/_services/sage_maker.py
| def describe_cluster_event(
self,
*,
config_overrides: Optional[SageMakerClientConfig] = None,
event_id: Optional["capo_sagemaker.types.event_id.EventId"] = None,
cluster_name: Optional[
"capo_sagemaker.types.cluster_name_or_arn.ClusterNameOrArn"
] = None,
) -> "capo_sagemaker.types.describe_cluster_event_response.DescribeClusterEventResponse":
"""<p>Retrieves detailed information about a specific event for a given HyperPod cluster. This functionality is only supported when the <code>NodeProvisioningMode</code> is set to <code>Continuous</code>.</p>
Args:
event_id: <p>The unique identifier (UUID) of the event to describe. This ID can be obtained from the <code>ListClusterEvents</code> operation.</p>
cluster_name: <p>The name or Amazon Resource Name (ARN) of the HyperPod cluster associated with the event.</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_event_request.DescribeClusterEventRequest]",
) -> OperationResponse[
"capo_sagemaker.types.describe_cluster_event_response.DescribeClusterEventResponse"
]:
import capo_sagemaker._operations.sage_maker.describe_cluster_event
output, http_response = (
capo_sagemaker._operations.sage_maker.describe_cluster_event.describe_cluster_event(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DescribeClusterEvent")
)
input_: capo_sagemaker.types.describe_cluster_event_request.DescribeClusterEventRequest = {}
if event_id is not None:
input_["event_id"] = event_id
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
|