View a markdown version of this page

ListClusterExtensionVersions - Amazon SageMaker

ListClusterExtensionVersions

Lists the versions of an extension that you can install on a SageMaker HyperPod cluster, from the highest version to the lowest. Use a version from this list as the ExtensionVersion in CreateClusterExtension or UpdateClusterExtension.

The list contains only versions that you can install. Versions that SageMaker HyperPod no longer offers for new installations don't appear. If SageMaker HyperPod doesn't offer an extension with the name that you specify, the response contains an empty list.

Request Syntax

{ "ExtensionName": "string", "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.

ExtensionName

The name of the extension whose versions you want to list, for example sagemaker-observability.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [a-z]([a-z0-9]|-[a-z0-9])*

Required: Yes

MaxResults

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

Type: Integer

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

Required: No

NextToken

If the result of the previous ListClusterExtensionVersions request was truncated, the response includes a NextToken. To retrieve the next set of versions, use the token in the next request.

Type: String

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

Pattern: .*

Required: No

Response Syntax

{ "ExtensionVersions": [ { "ExtensionVersion": "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.

ExtensionVersions

The versions of the extension that you can install, from the highest version to the lowest.

Type: Array of ExtensionVersionSummary objects

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

NextToken

If the response is truncated, a token that you can use in the next request to retrieve the next set of versions.

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.

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: