Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListClusterExtensions

Lists the extensions installed on a SageMaker HyperPod cluster.

Request Syntax


{
   "ClusterArn": "string",
   "CreationTimeAfter": number,
   "CreationTimeBefore": number,
   "MaxResults": number,
   "NextToken": "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 whose extensions you want to list.

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

CreationTimeAfter

A filter that returns extensions created at or after the specified time. Timestamps are formatted according to the ISO 8601 standard.

Type: Timestamp

Required: No

CreationTimeBefore

A filter that returns extensions created at or before the specified time. The acceptable formats are the same as the timestamp formats for CreationTimeAfter.

Type: Timestamp

Required: No

MaxResults

The maximum number of extensions to return in the response. If you don't specify a value, SageMaker HyperPod returns up to 100 extensions.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

NextToken

If the result of the previous ListClusterExtensions request was truncated, the response includes a NextToken. To retrieve the next set of extensions, use the token in the next request. When you use the CreationTimeAfter or CreationTimeBefore filters, a response can contain fewer extensions than MaxResults, or none, and still include a NextToken. Continue until the response doesn't include a NextToken.

Type: String

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

Pattern: .*

Required: No

Response Syntax


{
   "Extensions": [ 
      { 
         "CreationTime": number,
         "ExtensionArn": "string",
         "ExtensionName": "string",
         "ExtensionVersion": "string",
         "Status": "string"
      }
   ],
   "NextToken": "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.

Extensions

The list of extensions installed on the cluster.

Type: Array of ExtensionSummary objects

Array Members: Minimum number of 0 items. Maximum number of 100 items.

NextToken

The next token specified for listing extensions on a SageMaker HyperPod cluster.

Type: String

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

Pattern: .*

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