Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeClusterExtension

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.

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 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.

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


{
   "ExtensionDetails": { 
      "ClusterArn": "string",
      "ConfigurationValues": "string",
      "CreationTime": number,
      "ExtensionArn": "string",
      "ExtensionName": "string",
      "ExtensionVersion": "string",
      "LastModifiedTime": number,
      "Status": "string"
   },
   "NodeSummary": { 
      "ActiveCount": number,
      "TotalCount": number
   }
}

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.

ExtensionDetails

The details of the extension.

Type: ExtensionDetails object

NodeSummary

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.

Type: ExtensionNodeSummary object

Errors

For information about the errors that are common to all actions, see Common Error Types.

ResourceNotFound

Resource being access is not found.

HTTP Status Code: 400