Struct ListClustersInput

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

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.

creation_time_after: Option<DateTime>

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.

creation_time_before: Option<DateTime>

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.

max_results: Option<i32>

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.

name_contains: Option<String>

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

next_token: Option<String>

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

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.

training_plan_arn: Option<String>

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 .

Implementations

impl ListClustersInput

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

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.

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

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.

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

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.

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

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

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

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

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.

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

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 .

impl ListClustersInput

pub fn builder() -> ListClustersInputBuilder

Creates a new builder-style object to manufacture ListClustersInput.

Trait Implementations

impl Clone for ListClustersInput

fn clone(&self) -> ListClustersInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ListClustersInput

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

Formats the value using the given formatter.

impl PartialEq for ListClustersInput

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

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

const 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 ListClustersInput