Skip to content

ClusterSummary

Source code in docs_src/capo_sagemaker/types/cluster_summary.py
class ClusterSummary(TypedDict, closed=True):
    cluster_arn: NotRequired["capo_sagemaker.types.cluster_arn.ClusterArn"]
    """<p>The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster.</p>"""
    cluster_name: NotRequired["capo_sagemaker.types.cluster_name.ClusterName"]
    """<p>The name of the SageMaker HyperPod cluster.</p>"""
    creation_time: NotRequired["capo_sagemaker.types.timestamp.Timestamp"]
    """<p>The time when the SageMaker HyperPod cluster is created.</p>"""
    cluster_status: NotRequired["capo_sagemaker.types.cluster_status.ClusterStatus"]
    """<p>The status of the SageMaker HyperPod cluster.</p>"""
    training_plan_arns: NotRequired[
        "capo_sagemaker.types.training_plan_arns.TrainingPlanArns"
    ]
    """<p>A list of Amazon Resource Names (ARNs) of the training plans associated with this cluster.</p> <p>For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see <code> <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingPlan.html">CreateTrainingPlan</a> </code>.</p>"""
    image_version_status: NotRequired[
        "capo_sagemaker.types.cluster_image_version_status.ClusterImageVersionStatus"
    ]
    """<p>The aggregate status of the image version across the cluster's instance groups.</p>"""

cluster_arn instance-attribute

cluster_arn: NotRequired[ClusterArn]

The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster.

cluster_name instance-attribute

cluster_name: NotRequired[ClusterName]

The name of the SageMaker HyperPod cluster.

cluster_status instance-attribute

cluster_status: NotRequired[ClusterStatus]

The status of the SageMaker HyperPod cluster.

creation_time instance-attribute

creation_time: NotRequired[Timestamp]

The time when the SageMaker HyperPod cluster is created.

image_version_status instance-attribute

image_version_status: NotRequired[ClusterImageVersionStatus]

The aggregate status of the image version across the cluster's instance groups.

training_plan_arns instance-attribute

training_plan_arns: NotRequired[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 .