ClusterSummary
Lists a summary of the properties of a SageMaker HyperPod cluster.
Contents
- ClusterArn
-
The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster.
Type: String
Length Constraints: Maximum length of 256.
Pattern:
^arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:cluster/[a-z0-9]{12}$Required: Yes
- ClusterName
-
The name of the SageMaker HyperPod cluster.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern:
^[a-zA-Z0-9](-*[a-zA-Z0-9])*$Required: Yes
- ClusterStatus
-
The status of the SageMaker HyperPod cluster.
Type: String
Valid Values:
Creating | Deleting | Failed | InService | RollingBack | SystemUpdating | UpdatingRequired: Yes
- CreationTime
-
The time when the SageMaker HyperPod cluster is created.
Type: Timestamp
Required: Yes
- TrainingPlanArns
-
A list of Amazon Resource Names (ARNs) of the training plans associated with this cluster.
For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see
CreateTrainingPlan.Type: Array of strings
Length Constraints: Minimum length of 50. Maximum length of 2048.
Pattern:
arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:training-plan/.*Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
