AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

This is the response object from the DescribeCluster operation.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceResponse
    Amazon.SageMaker.Model.DescribeClusterResponse

Namespace: Amazon.SageMaker.Model
Assembly: AWSSDK.SageMaker.dll
Version: 3.x.y.z

Syntax

C# 
public class DescribeClusterResponse : AmazonWebServiceResponse

The DescribeClusterResponse type exposes the following members

Constructors

NameDescription
Public Method DescribeClusterResponse()

Properties

NameTypeDescription
Public Property AutoScaling Amazon.SageMaker.Model.ClusterAutoScalingConfigOutput

Gets and sets the property AutoScaling.

The current autoscaling configuration and status for the autoscaler.

Public Property ClusterArn System.String

Gets and sets the property ClusterArn.

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

Public Property ClusterName System.String

Gets and sets the property ClusterName.

The name of the SageMaker HyperPod cluster.

Public Property ClusterRole System.String

Gets and sets the property ClusterRole.

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

Public Property ClusterStatus Amazon.SageMaker.ClusterStatus

Gets and sets the property ClusterStatus.

The status of the SageMaker HyperPod cluster.

Public Property ContentLength System.Int64 Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property CreationTime System.DateTime

Gets and sets the property CreationTime.

The time when the SageMaker Cluster is created.

Public Property FailureMessage System.String

Gets and sets the property FailureMessage.

The failure message of the SageMaker HyperPod cluster.

Public Property HttpStatusCode System.Net.HttpStatusCode Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property InstanceGroups System.Collections.Generic.List<Amazon.SageMaker.Model.ClusterInstanceGroupDetails>

Gets and sets the property InstanceGroups.

The instance groups of the SageMaker HyperPod cluster.

Public Property NodeProvisioningMode Amazon.SageMaker.ClusterNodeProvisioningMode

Gets and sets the property NodeProvisioningMode.

The mode used for provisioning nodes in the cluster.

Public Property NodeRecovery Amazon.SageMaker.ClusterNodeRecovery

Gets and sets the property NodeRecovery.

The node recovery mode configured for the SageMaker HyperPod cluster.

Public Property Orchestrator Amazon.SageMaker.Model.ClusterOrchestrator

Gets and sets the property Orchestrator.

The type of orchestrator used for the SageMaker HyperPod cluster.

Public Property ResponseMetadata Amazon.Runtime.ResponseMetadata Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property RestrictedInstanceGroups System.Collections.Generic.List<Amazon.SageMaker.Model.ClusterRestrictedInstanceGroupDetails>

Gets and sets the property RestrictedInstanceGroups.

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

Public Property TieredStorageConfig Amazon.SageMaker.Model.ClusterTieredStorageConfig

Gets and sets the property TieredStorageConfig.

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.

Public Property VpcConfig Amazon.SageMaker.Model.VpcConfig

Gets and sets the property VpcConfig.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5