Struct aws_sdk_sagemaker::operation::list_cluster_nodes::builders::ListClusterNodesFluentBuilder

pub struct ListClusterNodesFluentBuilder { /* private fields */ }

Fluent builder constructing a request to ListClusterNodes.

Retrieves the list of instances (also called nodes interchangeably) in a SageMaker HyperPod cluster.

Implementations

impl ListClusterNodesFluentBuilder

pub fn as_input(&self) -> &ListClusterNodesInputBuilder

Access the ListClusterNodes as a reference.

pub async fn send( self ) -> Result<ListClusterNodesOutput, SdkError<ListClusterNodesError, HttpResponse>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn customize( self ) -> CustomizableOperation<ListClusterNodesOutput, ListClusterNodesError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

pub fn cluster_name(self, input: impl Into<String>) -> Self

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 set_cluster_name(self, input: Option<String>) -> Self

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 get_cluster_name(&self) -> &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.

pub fn creation_time_after(self, input: DateTime) -> Self

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 set_creation_time_after(self, input: Option<DateTime>) -> Self

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 get_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, input: DateTime) -> Self

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 set_creation_time_before(self, input: Option<DateTime>) -> Self

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 get_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, input: impl Into<String>) -> Self

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

pub fn set_instance_group_name_contains(self, input: Option<String>) -> Self

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

pub fn get_instance_group_name_contains(&self) -> &Option<String>

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

pub fn max_results(self, input: i32) -> Self

The maximum number of nodes to return in the response.

pub fn set_max_results(self, input: Option<i32>) -> Self

The maximum number of nodes to return in the response.

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

The maximum number of nodes to return in the response.

pub fn next_token(self, input: impl Into<String>) -> Self

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 set_next_token(self, input: Option<String>) -> Self

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 get_next_token(&self) -> &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.

pub fn sort_by(self, input: ClusterSortBy) -> Self

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

pub fn set_sort_by(self, input: Option<ClusterSortBy>) -> Self

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

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

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

pub fn sort_order(self, input: SortOrder) -> Self

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

pub fn set_sort_order(self, input: Option<SortOrder>) -> Self

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

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

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

Trait Implementations

impl Clone for ListClusterNodesFluentBuilder

fn clone(&self) -> ListClusterNodesFluentBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ListClusterNodesFluentBuilder

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

Formats the value using the given formatter.