DescribeClusterExtension
Retrieves information about an extension installed on a SageMaker HyperPod cluster. The information includes the extension's version, configuration, and status, and a summary of how many cluster nodes are running the current version and configuration of the extension. If the extension has problems on some nodes, the response also lists the problems and how many nodes each one affects.
Request Syntax
{
"ClusterArn": "string",
"ExtensionArn": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- ClusterArn
-
The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster on which the extension is installed.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Pattern:
arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:cluster/[a-z0-9]{12}Required: Yes
- ExtensionArn
-
The Amazon Resource Name (ARN) of the extension to describe.
CreateClusterExtensionreturns this ARN, andListClusterExtensionslists it. If you delete an extension and create it again, the new extension has a new ARN.Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:extension/(sagemaker|eks|pcs)-[a-z0-9-]+/[a-z0-9-]+/[a-z0-9]+Required: Yes
Response Syntax
{
"ExtensionDetails": {
"ClusterArn": "string",
"ConfigurationValues": "string",
"CreationTime": number,
"ExtensionArn": "string",
"ExtensionName": "string",
"ExtensionVersion": "string",
"LastModifiedTime": number,
"Status": "string"
},
"Health": {
"Issues": [
{
"Code": "string",
"Message": "string",
"NodeCount": number
}
]
},
"NodeSummary": {
"ActiveCount": number,
"TotalCount": number
}
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- ExtensionDetails
-
The details of the extension.
Type: ExtensionDetails object
- Health
-
The problems that affect the extension on the cluster's nodes, grouped by cause, with the number of nodes that each problem affects. Use it to find out why
ActiveCountis lower thanTotalCount, or why the status isDegraded,CreateFailed, orUpdateFailed. SageMaker HyperPod omitsHealthwhen no node has a problem. Nodes where SageMaker HyperPod hasn't finished installing or updating the extension aren't counted in any issue, unless an earlier attempt failed on them.Type: ExtensionHealth object
- NodeSummary
-
A summary of how many nodes in your cluster the extension targets, and how many of them run the extension's current version and configuration.
Type: ExtensionNodeSummary object
Errors
For information about the errors that are common to all actions, see Common Error Types.
- ResourceNotFound
-
Resource being access is not found.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: