Struct aws_sdk_memorydb::client::fluent_builders::DescribeSnapshots

pub struct DescribeSnapshots<C = DynConnector, M = AwsMiddleware, R = Standard> { /* fields omitted */ }

Fluent builder constructing a request to DescribeSnapshots.

Returns information about cluster snapshots. By default, DescribeSnapshots lists all of your snapshots; it can optionally describe a single snapshot, or just the snapshots associated with a particular cluster.

Implementations

impl<C, M, R> DescribeSnapshots<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<DescribeSnapshotsOutput, SdkError<DescribeSnapshotsError>> where
    R::Policy: SmithyRetryPolicy<DescribeSnapshotsInputOperationOutputAlias, DescribeSnapshotsOutput, DescribeSnapshotsError, DescribeSnapshotsInputOperationRetryAlias>, 

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 cluster_name(self, inp: impl Into<String>) -> Self

A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cluster are described.

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

A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cluster are described.

pub fn snapshot_name(self, inp: impl Into<String>) -> Self

A user-supplied name of the snapshot. If this parameter is specified, only this named snapshot is described.

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

A user-supplied name of the snapshot. If this parameter is specified, only this named snapshot is described.

pub fn source(self, inp: impl Into<String>) -> Self

If set to system, the output shows snapshots that were automatically created by MemoryDB. If set to user the output shows snapshots that were manually created. If omitted, the output shows both automatically and manually created snapshots.

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

If set to system, the output shows snapshots that were automatically created by MemoryDB. If set to user the output shows snapshots that were manually created. If omitted, the output shows both automatically and manually created snapshots.

pub fn next_token(self, inp: 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 max_results(self, inp: 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 show_detail(self, inp: bool) -> Self

A Boolean value which if true, the shard configuration is included in the snapshot description.

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

A Boolean value which if true, the shard configuration is included in the snapshot description.

Trait Implementations

impl<C: Debug, M: Debug, R: Debug> Debug for DescribeSnapshots<C, M, R>

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

Formats the value using the given formatter.