aws_sdk_odb/client/
list_db_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 [`ListDbNodes`](crate::operation::list_db_nodes::builders::ListDbNodesFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_db_nodes::builders::ListDbNodesFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`max_results(i32)`](crate::operation::list_db_nodes::builders::ListDbNodesFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_db_nodes::builders::ListDbNodesFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.</p> <p>Default: <code>10</code></p><br>
8    ///   - [`next_token(impl Into<String>)`](crate::operation::list_db_nodes::builders::ListDbNodesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_db_nodes::builders::ListDbNodesFluentBuilder::set_next_token):<br>required: **false**<br><p>The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.</p><br>
9    ///   - [`cloud_vm_cluster_id(impl Into<String>)`](crate::operation::list_db_nodes::builders::ListDbNodesFluentBuilder::cloud_vm_cluster_id) / [`set_cloud_vm_cluster_id(Option<String>)`](crate::operation::list_db_nodes::builders::ListDbNodesFluentBuilder::set_cloud_vm_cluster_id):<br>required: **true**<br><p>The unique identifier of the VM cluster.</p><br>
10    /// - On success, responds with [`ListDbNodesOutput`](crate::operation::list_db_nodes::ListDbNodesOutput) with field(s):
11    ///   - [`next_token(Option<String>)`](crate::operation::list_db_nodes::ListDbNodesOutput::next_token): <p>The token to include in another request to get the next page of items. This value is <code>null</code> when there are no more items to return.</p>
12    ///   - [`db_nodes(Vec::<DbNodeSummary>)`](crate::operation::list_db_nodes::ListDbNodesOutput::db_nodes): <p>The list of DB nodes along with their properties.</p>
13    /// - On failure, responds with [`SdkError<ListDbNodesError>`](crate::operation::list_db_nodes::ListDbNodesError)
14    pub fn list_db_nodes(&self) -> crate::operation::list_db_nodes::builders::ListDbNodesFluentBuilder {
15        crate::operation::list_db_nodes::builders::ListDbNodesFluentBuilder::new(self.handle.clone())
16    }
17}