Skip to content

DescribeClusterResponse

Source code in docs_src/capo_sagemaker/types/describe_cluster_response.py
class DescribeClusterResponse(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>"""
    cluster_status: NotRequired["capo_sagemaker.types.cluster_status.ClusterStatus"]
    """<p>The status of the SageMaker HyperPod cluster.</p>"""
    creation_time: NotRequired["capo_sagemaker.types.timestamp.Timestamp"]
    """<p>The time when the SageMaker Cluster is created.</p>"""
    failure_message: NotRequired["capo_sagemaker.types.string.String"]
    """<p>The failure message of the SageMaker HyperPod cluster.</p>"""
    instance_groups: NotRequired[
        "capo_sagemaker.types.cluster_instance_group_details_list.ClusterInstanceGroupDetailsList"
    ]
    """<p>The instance groups of the SageMaker HyperPod cluster.</p>"""
    restricted_instance_groups: NotRequired[
        "capo_sagemaker.types.cluster_restricted_instance_group_details_list.ClusterRestrictedInstanceGroupDetailsList"
    ]
    """<p>The specialized instance groups for training models like Amazon Nova to be created in the SageMaker HyperPod cluster.</p>"""
    restricted_instance_groups_config: NotRequired[
        "capo_sagemaker.types.cluster_restricted_instance_groups_config_output.ClusterRestrictedInstanceGroupsConfigOutput"
    ]
    """<p>The configuration for the restricted instance groups (RIG) in the SageMaker HyperPod cluster.</p>"""
    vpc_config: NotRequired["capo_sagemaker.types.vpc_config.VpcConfig"]
    orchestrator: NotRequired[
        "capo_sagemaker.types.cluster_orchestrator.ClusterOrchestrator"
    ]
    """<p>The type of orchestrator used for the SageMaker HyperPod cluster. </p>"""
    tiered_storage_config: NotRequired[
        "capo_sagemaker.types.cluster_tiered_storage_config.ClusterTieredStorageConfig"
    ]
    """<p>The current configuration for managed tier checkpointing on the HyperPod cluster. For example, this shows whether the feature is enabled and the percentage of cluster memory allocated for checkpoint storage.</p>"""
    node_recovery: NotRequired[
        "capo_sagemaker.types.cluster_node_recovery.ClusterNodeRecovery"
    ]
    """<p>The node recovery mode configured for the SageMaker HyperPod cluster.</p>"""
    node_provisioning_mode: NotRequired[
        "capo_sagemaker.types.cluster_node_provisioning_mode.ClusterNodeProvisioningMode"
    ]
    """<p>The mode used for provisioning nodes in the cluster.</p>"""
    cluster_role: NotRequired["capo_sagemaker.types.role_arn.RoleArn"]
    """<p>The Amazon Resource Name (ARN) of the IAM role that HyperPod uses for cluster autoscaling operations.</p>"""
    auto_scaling: NotRequired[
        "capo_sagemaker.types.cluster_auto_scaling_config_output.ClusterAutoScalingConfigOutput"
    ]
    """<p>The current autoscaling configuration and status for the autoscaler.</p>"""

auto_scaling instance-attribute

auto_scaling: NotRequired[ClusterAutoScalingConfigOutput]

The current autoscaling configuration and status for the autoscaler.

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_role instance-attribute

cluster_role: NotRequired[RoleArn]

The Amazon Resource Name (ARN) of the IAM role that HyperPod uses for cluster autoscaling operations.

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 Cluster is created.

failure_message instance-attribute

failure_message: NotRequired[String]

The failure message of the SageMaker HyperPod cluster.

instance_groups instance-attribute

instance_groups: NotRequired[ClusterInstanceGroupDetailsList]

The instance groups of the SageMaker HyperPod cluster.

node_provisioning_mode instance-attribute

node_provisioning_mode: NotRequired[ClusterNodeProvisioningMode]

The mode used for provisioning nodes in the cluster.

node_recovery instance-attribute

node_recovery: NotRequired[ClusterNodeRecovery]

The node recovery mode configured for the SageMaker HyperPod cluster.

orchestrator instance-attribute

orchestrator: NotRequired[ClusterOrchestrator]

The type of orchestrator used for the SageMaker HyperPod cluster.

restricted_instance_groups instance-attribute

restricted_instance_groups: NotRequired[ClusterRestrictedInstanceGroupDetailsList]

The specialized instance groups for training models like Amazon Nova to be created in the SageMaker HyperPod cluster.

restricted_instance_groups_config instance-attribute

restricted_instance_groups_config: NotRequired[
    ClusterRestrictedInstanceGroupsConfigOutput
]

The configuration for the restricted instance groups (RIG) in the SageMaker HyperPod cluster.

tiered_storage_config instance-attribute

tiered_storage_config: NotRequired[ClusterTieredStorageConfig]

The current configuration for managed tier checkpointing on the HyperPod cluster. For example, this shows whether the feature is enabled and the percentage of cluster memory allocated for checkpoint storage.

vpc_config instance-attribute

vpc_config: NotRequired[VpcConfig]