Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

UpdateClusterExtension

Updates the configuration or the version of an extension installed on a SageMaker HyperPod cluster. SageMaker HyperPod applies the change to every node in the cluster. You can change the configuration, the version, or both in one request.

Configuration: You can change settings by sending ConfigurationValues. Settings that you include are changed. Settings that you omit keep their current values. A setting with the value null is removed and returns to its default value.
Version: You can update to a later version. You can't update to an earlier version. To use an earlier version, delete the extension and create it again with that version.

You can't update an extension while it is being deleted.

Request Syntax


{
   "ClientToken": "string",
   "ClusterArn": "string",
   "ConfigurationValues": "string",
   "ExtensionArn": "string",
   "ExtensionVersion": "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.

ClientToken

A unique, case-sensitive identifier that you provide so that the request is idempotent. If you send the same update more than once, SageMaker HyperPod applies it once and doesn't return an error.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 64.

Pattern: [\x21-\x7E]+

Required: No

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

ConfigurationValues

The configuration changes to apply, as a JSON object serialized as a string. Settings that you include are changed, settings that you omit are unchanged, and a setting with the value null returns to its default value. The resulting configuration must be valid for the target extension version. If you omit ConfigurationValues, the configuration is unchanged.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 10240.

Required: No

ExtensionArn

The Amazon Resource Name (ARN) of the extension to update.

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

ExtensionVersion

The version to update the extension to, in MAJOR.MINOR.PATCH format. The version must be later than the extension's current version. If you omit this parameter, the extension keeps its current version.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [0-9]+\.[0-9]+\.[0-9]+

Required: No

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 updated. To track the update, call DescribeClusterExtension.

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 Experiment or Artifact.

HTTP Status Code: 400

ResourceNotFound

Resource being access is not found.

HTTP Status Code: 400