SageMaker / Client / create_cluster_extension

create_cluster_extension

SageMaker.Client.create_cluster_extension(**kwargs)

Installs an extension, such as sagemaker-observability, on a SageMaker HyperPod cluster orchestrated by Slurm. The cluster must have NodeProvisioningMode set to Continuous and can have only one extension with a given name. To track the installation, call DescribeClusterExtension.

See also: AWS API Documentation

Request Syntax

response = client.create_cluster_extension(
    ClusterArn='string',
    ExtensionName='string',
    ExtensionVersion='string',
    ConfigurationValues='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    ClientToken='string'
)
Parameters:

  • ClusterArn (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster on which to install the extension. The cluster must use Slurm as the orchestrator and have NodeProvisioningMode set to Continuous.

  • ExtensionName (string) –

    [REQUIRED]

    The name of the extension to install, for example sagemaker-observability.

  • ExtensionVersion (string) – The version of the extension to install, in MAJOR.MINOR.PATCH format, for example 1.0.0. If you don’t specify a version, SageMaker HyperPod installs the latest available version of the extension.

  • ConfigurationValues (string) – The configuration settings for the extension, as a JSON object serialized as a string, for example {"metricsProvider":{"nodeMetrics":{"level":"ADVANCED"}}}. Each extension version defines which settings it accepts. SageMaker HyperPod validates the settings against that definition, and rejects the request if a setting is unknown or has an invalid value. Settings that you omit use the extension’s default values. If you omit ConfigurationValues, all settings use their default values.

  • Tags (list) –

    Custom tags for managing the extension as an Amazon Web Services resource. You can add tags to your extension in the same way you add them in other Amazon Web Services services that support tagging. To learn more about tagging Amazon Web Services resources in general, see Tagging Amazon Web Services Resources User Guide. To use this operation to add tags when you create an extension, you must have the sagemaker:AddTags permission.

    • (dict) –

      A tag object that consists of a key and an optional value, used to manage metadata for SageMaker Amazon Web Services resources.

      You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints. For more information on adding tags to SageMaker resources, see AddTags.

      For more information on adding metadata to your Amazon Web Services resources with tagging, see Tagging Amazon Web Services resources. For advice on best practices for managing Amazon Web Services resources with tagging, see Tagging Best Practices: Implement an Effective Amazon Web Services Resource Tagging Strategy.

      • Key (string) – [REQUIRED]

        The tag key. Tag keys must be unique per resource.

      • Value (string) – [REQUIRED]

        The tag value.

  • ClientToken (string) –

    A unique, case-sensitive identifier that you provide so that the operation completes no more than one time. This token is valid for 8 hours. If you retry the request with the same client token and the same parameters within this time, the API returns the Amazon Resource Name (ARN) of the extension that the original request created, without creating a duplicate. If you use the same client token with different parameters, the request fails.

    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 you created. Use this ARN to describe, update, or delete the extension.

Exceptions