DeleteClusterExtension
Deletes an extension from a SageMaker HyperPod cluster. SageMaker HyperPod removes the extension's software
from every node in the cluster. While SageMaker HyperPod removes the extension, its status is
Deleting. After SageMaker HyperPod removes the extension from all nodes, it no longer
appears in ListClusterExtensions, and DescribeClusterExtension
returns a ResourceNotFound error.
Deleting an extension doesn't delete data that the extension sent to other AWS services, such as metrics in Amazon CloudWatch or Amazon Managed Service for Prometheus.
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 delete.
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
{
"ExtensionArn": "string"
}
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.
- ExtensionArn
-
The Amazon Resource Name (ARN) of the extension that is being deleted.
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]+
Errors
For information about the errors that are common to all actions, see Common Error Types.
- ConflictException
-
There was a conflict when you attempted to modify a SageMaker entity such as an
ExperimentorArtifact.HTTP Status Code: 400
- ResourceInUse
-
Resource being accessed is in use.
HTTP Status Code: 400
- 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 AWS SDKs, see the following: