Struct ListClusterNodesInput

#[non_exhaustive]
pub struct ListClusterNodesInput {
    pub cluster_name: Option<String>,
    pub creation_time_after: Option<DateTime>,
    pub creation_time_before: Option<DateTime>,
    pub instance_group_name_contains: Option<String>,
    pub max_results: Option<i32>,
    pub next_token: Option<String>,
    pub sort_by: Option<ClusterSortBy>,
    pub sort_order: Option<SortOrder>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

cluster_name: Option<String>

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

creation_time_after: Option<DateTime>

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.

creation_time_before: Option<DateTime>

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.

instance_group_name_contains: Option<String>

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

max_results: Option<i32>

The maximum number of nodes to return in the response.

next_token: Option<String>

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.

sort_by: Option<ClusterSortBy>

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

sort_order: Option<SortOrder>

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

Implementations

impl ListClusterNodesInput

pub fn cluster_name(&self) -> Option<&str>

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

pub fn creation_time_after(&self) -> Option<&DateTime>

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.

pub fn creation_time_before(&self) -> Option<&DateTime>

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.

pub fn instance_group_name_contains(&self) -> Option<&str>

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

pub fn max_results(&self) -> Option<i32>

The maximum number of nodes to return in the response.

pub fn next_token(&self) -> Option<&str>

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.

pub fn sort_by(&self) -> Option<&ClusterSortBy>

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

pub fn sort_order(&self) -> Option<&SortOrder>

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

impl ListClusterNodesInput

pub fn builder() -> ListClusterNodesInputBuilder

Creates a new builder-style object to manufacture ListClusterNodesInput.

Trait Implementations

impl Clone for ListClusterNodesInput

fn clone(&self) -> ListClusterNodesInput

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ListClusterNodesInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for ListClusterNodesInput

fn eq(&self, other: &ListClusterNodesInput) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ListClusterNodesInput