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.

Container for the parameters to the ListClusters operation. Retrieves the list of SageMaker HyperPod clusters.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.SageMaker.AmazonSageMakerRequest
      Amazon.SageMaker.Model.ListClustersRequest

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

Syntax

C#
public class ListClustersRequest : AmazonSageMakerRequest
         IAmazonWebServiceRequest

The ListClustersRequest type exposes the following members

Constructors

NameDescription
Public Method ListClustersRequest()

Properties

NameTypeDescription
Public Property CreationTimeAfter System.DateTime

Gets and sets the property CreationTimeAfter.

Set a start time for the time range during which you want to list SageMaker HyperPod clusters. Timestamps are formatted according to the ISO 8601 standard.

Acceptable formats include:

  • YYYY-MM-DDThh:mm:ss.sssTZD (UTC), for example, 2014-10-01T20:30:00.000Z

  • YYYY-MM-DDThh:mm:ss.sssTZD (with offset), for example, 2014-10-01T12:30:00.000-08:00

  • YYYY-MM-DD, for example, 2014-10-01

  • Unix time in seconds, for example, 1412195400. This is also referred to as Unix Epoch time and represents the number of seconds since midnight, January 1, 1970 UTC.

For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User Guide.

Public Property CreationTimeBefore System.DateTime

Gets and sets the property CreationTimeBefore.

Set an end time for the time range during which you want to list SageMaker HyperPod clusters. A filter that returns nodes in a SageMaker HyperPod cluster created before the specified time. The acceptable formats are the same as the timestamp formats for CreationTimeAfter. For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User Guide.

Public Property MaxResults System.Int32

Gets and sets the property MaxResults.

Specifies the maximum number of clusters to evaluate for the operation (not necessarily the number of matching items). After SageMaker processes the number of clusters up to MaxResults, it stops the operation and returns the matching clusters up to that point. If all the matching clusters are desired, SageMaker will go through all the clusters until NextToken is empty.

Public Property NameContains System.String

Gets and sets the property NameContains.

Set the maximum number of instances to print in the list.

Public Property NextToken System.String

Gets and sets the property NextToken.

Set the next token to retrieve the list of SageMaker HyperPod clusters.

Public Property SortBy Amazon.SageMaker.ClusterSortBy

Gets and sets the property SortBy.

The field by which to sort results. The default value is CREATION_TIME.

Public Property SortOrder Amazon.SageMaker.SortOrder

Gets and sets the property SortOrder.

The sort order for results. The default value is Ascending.

Public Property TrainingPlanArn System.String

Gets and sets the property TrainingPlanArn.

The Amazon Resource Name (ARN); of the training plan to filter clusters by. For more information about reserving GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see CreateTrainingPlan .

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