aws_sdk_memorydb/client/
describe_multi_region_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 [`DescribeMultiRegionClusters`](crate::operation::describe_multi_region_clusters::builders::DescribeMultiRegionClustersFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_multi_region_clusters::builders::DescribeMultiRegionClustersFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`multi_region_cluster_name(impl Into<String>)`](crate::operation::describe_multi_region_clusters::builders::DescribeMultiRegionClustersFluentBuilder::multi_region_cluster_name) / [`set_multi_region_cluster_name(Option<String>)`](crate::operation::describe_multi_region_clusters::builders::DescribeMultiRegionClustersFluentBuilder::set_multi_region_cluster_name):<br>required: **false**<br><p>The name of a specific multi-Region cluster to describe.</p><br>
8    ///   - [`max_results(i32)`](crate::operation::describe_multi_region_clusters::builders::DescribeMultiRegionClustersFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::describe_multi_region_clusters::builders::DescribeMultiRegionClustersFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return.</p><br>
9    ///   - [`next_token(impl Into<String>)`](crate::operation::describe_multi_region_clusters::builders::DescribeMultiRegionClustersFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::describe_multi_region_clusters::builders::DescribeMultiRegionClustersFluentBuilder::set_next_token):<br>required: **false**<br><p>A token to specify where to start paginating.</p><br>
10    ///   - [`show_cluster_details(bool)`](crate::operation::describe_multi_region_clusters::builders::DescribeMultiRegionClustersFluentBuilder::show_cluster_details) / [`set_show_cluster_details(Option<bool>)`](crate::operation::describe_multi_region_clusters::builders::DescribeMultiRegionClustersFluentBuilder::set_show_cluster_details):<br>required: **false**<br><p>Details about the multi-Region cluster.</p><br>
11    /// - On success, responds with [`DescribeMultiRegionClustersOutput`](crate::operation::describe_multi_region_clusters::DescribeMultiRegionClustersOutput) with field(s):
12    ///   - [`next_token(Option<String>)`](crate::operation::describe_multi_region_clusters::DescribeMultiRegionClustersOutput::next_token): <p>A token to use to retrieve the next page of results.</p>
13    ///   - [`multi_region_clusters(Option<Vec::<MultiRegionCluster>>)`](crate::operation::describe_multi_region_clusters::DescribeMultiRegionClustersOutput::multi_region_clusters): <p>A list of multi-Region clusters.</p>
14    /// - On failure, responds with [`SdkError<DescribeMultiRegionClustersError>`](crate::operation::describe_multi_region_clusters::DescribeMultiRegionClustersError)
15    pub fn describe_multi_region_clusters(
16        &self,
17    ) -> crate::operation::describe_multi_region_clusters::builders::DescribeMultiRegionClustersFluentBuilder {
18        crate::operation::describe_multi_region_clusters::builders::DescribeMultiRegionClustersFluentBuilder::new(self.handle.clone())
19    }
20}