SageMaker / Client / describe_cluster_extension

describe_cluster_extension

SageMaker.Client.describe_cluster_extension(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.describe_cluster_extension(
    ClusterArn='string',
    ExtensionArn='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 describe. CreateClusterExtension returns this ARN, and ListClusterExtensions lists it. If you delete an extension and create it again, the new extension has a new ARN.

Return type:

dict

Returns:

Response Syntax

{
    'ExtensionDetails': {
        'ClusterArn': 'string',
        'ExtensionArn': 'string',
        'ExtensionName': 'string',
        'ExtensionVersion': 'string',
        'Status': 'Creating'|'Active'|'CreateFailed'|'Updating'|'Deleting'|'DeleteFailed'|'Degraded'|'UpdateFailed',
        'ConfigurationValues': 'string',
        'CreationTime': datetime(2015, 1, 1),
        'LastModifiedTime': datetime(2015, 1, 1)
    },
    'NodeSummary': {
        'TotalCount': 123,
        'ActiveCount': 123
    }
}

Response Structure

  • (dict) –

    • ExtensionDetails (dict) –

      The details of the extension.

      • ClusterArn (string) –

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

      • ExtensionArn (string) –

        The Amazon Resource Name (ARN) of the extension.

      • ExtensionName (string) –

        The name of the extension.

      • ExtensionVersion (string) –

        The version of the extension. While SageMaker HyperPod creates or updates the extension, some nodes might still run a different version. To see how many nodes run this version, see NodeSummary.

      • Status (string) –

        The status of the extension can be one of the following values:

        Creating

        SageMaker HyperPod is installing the extension on the cluster’s nodes.

        Active

        The extension runs its current version and configuration on all of the cluster’s nodes.

        Updating

        SageMaker HyperPod is applying a configuration change or version update to the cluster’s nodes.

        Degraded

        The extension runs its current version and configuration on some of the cluster’s nodes but not all of them. Or, at least one node recently reported that the extension is unhealthy.

        CreateFailed

        SageMaker HyperPod couldn’t install the extension on any of the cluster’s nodes.

        UpdateFailed

        SageMaker HyperPod couldn’t apply the update on any of the cluster’s nodes.

        Deleting

        SageMaker HyperPod is removing the extension from the cluster’s nodes.

        DeleteFailed

        SageMaker HyperPod couldn’t remove the extension from any of the cluster’s nodes.

      • ConfigurationValues (string) –

        The configuration of the extension, as a JSON object serialized as a string. The configuration includes the default value of every setting that you didn’t specify.

      • CreationTime (datetime) –

        The time when the extension was created.

      • LastModifiedTime (datetime) –

        The time when the extension was last updated.

    • NodeSummary (dict) –

      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.

      • TotalCount (integer) –

        The number of nodes in your cluster that the extension targets. SageMaker HyperPod targets every running node in your cluster, including nodes that you add after you create the extension.

      • ActiveCount (integer) –

        The number of nodes that are running the extension’s current version and configuration. While SageMaker HyperPod creates or updates the extension, ActiveCount is lower than TotalCount.

Exceptions