SageMaker / Client / update_cluster_extension

update_cluster_extension

SageMaker.Client.update_cluster_extension(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.update_cluster_extension(
    ClusterArn='string',
    ExtensionArn='string',
    ExtensionVersion='string',
    ConfigurationValues='string',
    ClientToken='string'
)
Parameters:

  • ClusterArn (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster on which the extension is installed.

  • ExtensionArn (string) –

    [REQUIRED]

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

  • ExtensionVersion (string) – 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.

  • ConfigurationValues (string) – 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.

  • ClientToken (string) –

    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.

    This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{
    'ExtensionArn': 'string'
}

Response Structure

  • (dict) –

    • ExtensionArn (string) –

      The Amazon Resource Name (ARN) of the extension that is being updated. To track the update, call DescribeClusterExtension.

Exceptions