aws_sdk_sagemaker/client/

list_cluster_nodes.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListClusterNodes`](crate::operation::list_cluster_nodes::builders::ListClusterNodesFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_cluster_nodes::builders::ListClusterNodesFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`cluster_name(impl Into<String>)`](crate::operation::list_cluster_nodes::builders::ListClusterNodesFluentBuilder::cluster_name) / [`set_cluster_name(Option<String>)`](crate::operation::list_cluster_nodes::builders::ListClusterNodesFluentBuilder::set_cluster_name):<br>required: **true**<br><p>The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster in which you want to retrieve the list of nodes.</p><br>
    ///   - [`creation_time_after(DateTime)`](crate::operation::list_cluster_nodes::builders::ListClusterNodesFluentBuilder::creation_time_after) / [`set_creation_time_after(Option<DateTime>)`](crate::operation::list_cluster_nodes::builders::ListClusterNodesFluentBuilder::set_creation_time_after):<br>required: **false**<br><p>A filter that returns nodes in a SageMaker HyperPod cluster created after the specified time. Timestamps are formatted according to the ISO 8601 standard.</p> <p>Acceptable formats include:</p> <ul>  <li>   <p><code>YYYY-MM-DDThh:mm:ss.sssTZD</code> (UTC), for example, <code>2014-10-01T20:30:00.000Z</code></p></li>  <li>   <p><code>YYYY-MM-DDThh:mm:ss.sssTZD</code> (with offset), for example, <code>2014-10-01T12:30:00.000-08:00</code></p></li>  <li>   <p><code>YYYY-MM-DD</code>, for example, <code>2014-10-01</code></p></li>  <li>   <p>Unix time in seconds, for example, <code>1412195400</code>. This is also referred to as Unix Epoch time and represents the number of seconds since midnight, January 1, 1970 UTC.</p></li> </ul> <p>For more information about the timestamp format, see <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-types.html#parameter-type-timestamp">Timestamp</a> in the <i>Amazon Web Services Command Line Interface User Guide</i>.</p><br>
    ///   - [`creation_time_before(DateTime)`](crate::operation::list_cluster_nodes::builders::ListClusterNodesFluentBuilder::creation_time_before) / [`set_creation_time_before(Option<DateTime>)`](crate::operation::list_cluster_nodes::builders::ListClusterNodesFluentBuilder::set_creation_time_before):<br>required: **false**<br><p>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 <code>CreationTimeAfter</code>. For more information about the timestamp format, see <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-types.html#parameter-type-timestamp">Timestamp</a> in the <i>Amazon Web Services Command Line Interface User Guide</i>.</p><br>
    ///   - [`instance_group_name_contains(impl Into<String>)`](crate::operation::list_cluster_nodes::builders::ListClusterNodesFluentBuilder::instance_group_name_contains) / [`set_instance_group_name_contains(Option<String>)`](crate::operation::list_cluster_nodes::builders::ListClusterNodesFluentBuilder::set_instance_group_name_contains):<br>required: **false**<br><p>A filter that returns the instance groups whose name contain a specified string.</p><br>
    ///   - [`max_results(i32)`](crate::operation::list_cluster_nodes::builders::ListClusterNodesFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_cluster_nodes::builders::ListClusterNodesFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of nodes to return in the response.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::list_cluster_nodes::builders::ListClusterNodesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_cluster_nodes::builders::ListClusterNodesFluentBuilder::set_next_token):<br>required: **false**<br><p>If the result of the previous <code>ListClusterNodes</code> request was truncated, the response includes a <code>NextToken</code>. To retrieve the next set of cluster nodes, use the token in the next request.</p><br>
    ///   - [`sort_by(ClusterSortBy)`](crate::operation::list_cluster_nodes::builders::ListClusterNodesFluentBuilder::sort_by) / [`set_sort_by(Option<ClusterSortBy>)`](crate::operation::list_cluster_nodes::builders::ListClusterNodesFluentBuilder::set_sort_by):<br>required: **false**<br><p>The field by which to sort results. The default value is <code>CREATION_TIME</code>.</p><br>
    ///   - [`sort_order(SortOrder)`](crate::operation::list_cluster_nodes::builders::ListClusterNodesFluentBuilder::sort_order) / [`set_sort_order(Option<SortOrder>)`](crate::operation::list_cluster_nodes::builders::ListClusterNodesFluentBuilder::set_sort_order):<br>required: **false**<br><p>The sort order for results. The default value is <code>Ascending</code>.</p><br>
    ///   - [`include_node_logical_ids(bool)`](crate::operation::list_cluster_nodes::builders::ListClusterNodesFluentBuilder::include_node_logical_ids) / [`set_include_node_logical_ids(Option<bool>)`](crate::operation::list_cluster_nodes::builders::ListClusterNodesFluentBuilder::set_include_node_logical_ids):<br>required: **false**<br><p>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 <code>False</code> (default), only nodes with assigned <code>InstanceIds</code> are returned.</p><br>
    /// - On success, responds with [`ListClusterNodesOutput`](crate::operation::list_cluster_nodes::ListClusterNodesOutput) with field(s):
    ///   - [`next_token(Option<String>)`](crate::operation::list_cluster_nodes::ListClusterNodesOutput::next_token): <p>The next token specified for listing instances in a SageMaker HyperPod cluster.</p>
    ///   - [`cluster_node_summaries(Option<Vec::<ClusterNodeSummary>>)`](crate::operation::list_cluster_nodes::ListClusterNodesOutput::cluster_node_summaries): <p>The summaries of listed instances in a SageMaker HyperPod cluster</p>
    /// - On failure, responds with [`SdkError<ListClusterNodesError>`](crate::operation::list_cluster_nodes::ListClusterNodesError)
    pub fn list_cluster_nodes(&self) -> crate::operation::list_cluster_nodes::builders::ListClusterNodesFluentBuilder {
        crate::operation::list_cluster_nodes::builders::ListClusterNodesFluentBuilder::new(self.handle.clone())
    }
}