aws_sdk_memorydb/client/
describe_clusters.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 [`DescribeClusters`](crate::operation::describe_clusters::builders::DescribeClustersFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_clusters::builders::DescribeClustersFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`cluster_name(impl Into<String>)`](crate::operation::describe_clusters::builders::DescribeClustersFluentBuilder::cluster_name) / [`set_cluster_name(Option<String>)`](crate::operation::describe_clusters::builders::DescribeClustersFluentBuilder::set_cluster_name):<br>required: **false**<br><p>The name of the cluster.</p><br>
8    ///   - [`max_results(i32)`](crate::operation::describe_clusters::builders::DescribeClustersFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::describe_clusters::builders::DescribeClustersFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.</p><br>
9    ///   - [`next_token(impl Into<String>)`](crate::operation::describe_clusters::builders::DescribeClustersFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::describe_clusters::builders::DescribeClustersFluentBuilder::set_next_token):<br>required: **false**<br><p>An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.</p><br>
10    ///   - [`show_shard_details(bool)`](crate::operation::describe_clusters::builders::DescribeClustersFluentBuilder::show_shard_details) / [`set_show_shard_details(Option<bool>)`](crate::operation::describe_clusters::builders::DescribeClustersFluentBuilder::set_show_shard_details):<br>required: **false**<br><p>An optional flag that can be included in the request to retrieve information about the individual shard(s).</p><br>
11    /// - On success, responds with [`DescribeClustersOutput`](crate::operation::describe_clusters::DescribeClustersOutput) with field(s):
12    ///   - [`next_token(Option<String>)`](crate::operation::describe_clusters::DescribeClustersOutput::next_token): <p>An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.</p>
13    ///   - [`clusters(Option<Vec::<Cluster>>)`](crate::operation::describe_clusters::DescribeClustersOutput::clusters): <p>A list of clusters</p>
14    /// - On failure, responds with [`SdkError<DescribeClustersError>`](crate::operation::describe_clusters::DescribeClustersError)
15    pub fn describe_clusters(&self) -> crate::operation::describe_clusters::builders::DescribeClustersFluentBuilder {
16        crate::operation::describe_clusters::builders::DescribeClustersFluentBuilder::new(self.handle.clone())
17    }
18}
aws_sdk_memorydb/client/describe_clusters.rs

aws_sdk_memorydb/client/
describe_clusters.rs
