Struct aws_sdk_memorydb::client::fluent_builders::DescribeClusters

pub struct DescribeClusters { /* private fields */ }

Fluent builder constructing a request to DescribeClusters.

Returns information about all provisioned clusters if no cluster identifier is specified, or about a specific cluster if a cluster name is supplied.

Implementations

impl DescribeClusters

pub async fn customize(
    self
) -> Result<CustomizableOperation<DescribeClusters, AwsResponseRetryClassifier>, SdkError<DescribeClustersError>>

Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.

pub async fn send(
    self
) -> Result<DescribeClustersOutput, SdkError<DescribeClustersError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn into_paginator(self) -> DescribeClustersPaginator

Create a paginator for this request

Paginators are used by calling send().await which returns a Stream.

pub fn cluster_name(self, input: impl Into<String>) -> Self

The name of the cluster

pub fn set_cluster_name(self, input: Option<String>) -> Self

The name of the cluster

pub fn max_results(self, input: i32) -> Self

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.

pub fn set_max_results(self, input: Option<i32>) -> Self

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.

pub fn next_token(self, input: impl Into<String>) -> Self

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.

pub fn set_next_token(self, input: Option<String>) -> Self

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.

pub fn show_shard_details(self, input: bool) -> Self

An optional flag that can be included in the request to retrieve information about the individual shard(s).

pub fn set_show_shard_details(self, input: Option<bool>) -> Self

An optional flag that can be included in the request to retrieve information about the individual shard(s).

Trait Implementations

impl Clone for DescribeClusters

fn clone(&self) -> DescribeClusters

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DescribeClusters

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.