aws_sdk_finspace/client/list_kx_cluster_nodes.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3 /// Constructs a fluent builder for the [`ListKxClusterNodes`](crate::operation::list_kx_cluster_nodes::builders::ListKxClusterNodesFluentBuilder) operation.
4 /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_kx_cluster_nodes::builders::ListKxClusterNodesFluentBuilder::into_paginator).
5 ///
6 /// - The fluent builder is configurable:
7 /// - [`environment_id(impl Into<String>)`](crate::operation::list_kx_cluster_nodes::builders::ListKxClusterNodesFluentBuilder::environment_id) / [`set_environment_id(Option<String>)`](crate::operation::list_kx_cluster_nodes::builders::ListKxClusterNodesFluentBuilder::set_environment_id):<br>required: **true**<br><p>A unique identifier for the kdb environment.</p><br>
8 /// - [`cluster_name(impl Into<String>)`](crate::operation::list_kx_cluster_nodes::builders::ListKxClusterNodesFluentBuilder::cluster_name) / [`set_cluster_name(Option<String>)`](crate::operation::list_kx_cluster_nodes::builders::ListKxClusterNodesFluentBuilder::set_cluster_name):<br>required: **true**<br><p>A unique name for the cluster.</p><br>
9 /// - [`next_token(impl Into<String>)`](crate::operation::list_kx_cluster_nodes::builders::ListKxClusterNodesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_kx_cluster_nodes::builders::ListKxClusterNodesFluentBuilder::set_next_token):<br>required: **false**<br><p>A token that indicates where a results page should begin.</p><br>
10 /// - [`max_results(i32)`](crate::operation::list_kx_cluster_nodes::builders::ListKxClusterNodesFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_kx_cluster_nodes::builders::ListKxClusterNodesFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return in this request.</p><br>
11 /// - On success, responds with [`ListKxClusterNodesOutput`](crate::operation::list_kx_cluster_nodes::ListKxClusterNodesOutput) with field(s):
12 /// - [`nodes(Option<Vec::<KxNode>>)`](crate::operation::list_kx_cluster_nodes::ListKxClusterNodesOutput::nodes): <p>A list of nodes associated with the cluster.</p>
13 /// - [`next_token(Option<String>)`](crate::operation::list_kx_cluster_nodes::ListKxClusterNodesOutput::next_token): <p>A token that indicates where a results page should begin.</p>
14 /// - On failure, responds with [`SdkError<ListKxClusterNodesError>`](crate::operation::list_kx_cluster_nodes::ListKxClusterNodesError)
15 pub fn list_kx_cluster_nodes(&self) -> crate::operation::list_kx_cluster_nodes::builders::ListKxClusterNodesFluentBuilder {
16 crate::operation::list_kx_cluster_nodes::builders::ListKxClusterNodesFluentBuilder::new(self.handle.clone())
17 }
18}