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 ListClusterNodes operation. Retrieves the list of instances (also called nodes interchangeably) in a SageMaker HyperPod cluster.

Inheritance Hierarchy

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

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

Syntax

C#
public class ListClusterNodesRequest : AmazonSageMakerRequest
         IAmazonWebServiceRequest

The ListClusterNodesRequest type exposes the following members

Constructors

NameDescription
Public Method ListClusterNodesRequest()

Properties

NameTypeDescription
Public Property ClusterName System.String

Gets and sets the property ClusterName.

The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster in which you want to retrieve the list of nodes.

Public Property CreationTimeAfter System.DateTime

Gets and sets the property CreationTimeAfter.

A filter that returns nodes in a SageMaker HyperPod cluster created after the specified time. 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.

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 IncludeNodeLogicalIds System.Boolean

Gets and sets the property IncludeNodeLogicalIds.

Specifies whether to include nodes that are still being provisioned in the response. When set to true, the response includes all nodes regardless of their provisioning status. When set to False (default), only nodes with assigned InstanceIds are returned.

Public Property InstanceGroupNameContains System.String

Gets and sets the property InstanceGroupNameContains.

A filter that returns the instance groups whose name contain a specified string.

Public Property MaxResults System.Int32

Gets and sets the property MaxResults.

The maximum number of nodes to return in the response.

Public Property NextToken System.String

Gets and sets the property NextToken.

If the result of the previous ListClusterNodes request was truncated, the response includes a NextToken. To retrieve the next set of cluster nodes, use the token in the next request.

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.

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