aws_sdk_elasticache/client/describe_serverless_cache_snapshots.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 [`DescribeServerlessCacheSnapshots`](crate::operation::describe_serverless_cache_snapshots::builders::DescribeServerlessCacheSnapshotsFluentBuilder) operation.
4 /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_serverless_cache_snapshots::builders::DescribeServerlessCacheSnapshotsFluentBuilder::into_paginator).
5 ///
6 /// - The fluent builder is configurable:
7 /// - [`serverless_cache_name(impl Into<String>)`](crate::operation::describe_serverless_cache_snapshots::builders::DescribeServerlessCacheSnapshotsFluentBuilder::serverless_cache_name) / [`set_serverless_cache_name(Option<String>)`](crate::operation::describe_serverless_cache_snapshots::builders::DescribeServerlessCacheSnapshotsFluentBuilder::set_serverless_cache_name):<br>required: **false**<br><p>The identifier of serverless cache. If this parameter is specified, only snapshots associated with that specific serverless cache are described. Available for Valkey, Redis OSS and Serverless Memcached only.</p><br>
8 /// - [`serverless_cache_snapshot_name(impl Into<String>)`](crate::operation::describe_serverless_cache_snapshots::builders::DescribeServerlessCacheSnapshotsFluentBuilder::serverless_cache_snapshot_name) / [`set_serverless_cache_snapshot_name(Option<String>)`](crate::operation::describe_serverless_cache_snapshots::builders::DescribeServerlessCacheSnapshotsFluentBuilder::set_serverless_cache_snapshot_name):<br>required: **false**<br><p>The identifier of the serverless cache’s snapshot. If this parameter is specified, only this snapshot is described. Available for Valkey, Redis OSS and Serverless Memcached only.</p><br>
9 /// - [`snapshot_type(impl Into<String>)`](crate::operation::describe_serverless_cache_snapshots::builders::DescribeServerlessCacheSnapshotsFluentBuilder::snapshot_type) / [`set_snapshot_type(Option<String>)`](crate::operation::describe_serverless_cache_snapshots::builders::DescribeServerlessCacheSnapshotsFluentBuilder::set_snapshot_type):<br>required: **false**<br><p>The type of snapshot that is being described. Available for Valkey, Redis OSS and Serverless Memcached only.</p><br>
10 /// - [`next_token(impl Into<String>)`](crate::operation::describe_serverless_cache_snapshots::builders::DescribeServerlessCacheSnapshotsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::describe_serverless_cache_snapshots::builders::DescribeServerlessCacheSnapshotsFluentBuilder::set_next_token):<br>required: **false**<br><p>An optional marker returned from a prior request to support pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by max-results. Available for Valkey, Redis OSS and Serverless Memcached only.</p><br>
11 /// - [`max_results(i32)`](crate::operation::describe_serverless_cache_snapshots::builders::DescribeServerlessCacheSnapshotsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::describe_serverless_cache_snapshots::builders::DescribeServerlessCacheSnapshotsFluentBuilder::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 max-results value, a market is included in the response so that remaining results can be retrieved. Available for Valkey, Redis OSS and Serverless Memcached only.The default is 50. The Validation Constraints are a maximum of 50.</p><br>
12 /// - On success, responds with [`DescribeServerlessCacheSnapshotsOutput`](crate::operation::describe_serverless_cache_snapshots::DescribeServerlessCacheSnapshotsOutput) with field(s):
13 /// - [`next_token(Option<String>)`](crate::operation::describe_serverless_cache_snapshots::DescribeServerlessCacheSnapshotsOutput::next_token): <p>An optional marker returned from a prior request to support pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by max-results. Available for Valkey, Redis OSS and Serverless Memcached only.</p>
14 /// - [`serverless_cache_snapshots(Option<Vec::<ServerlessCacheSnapshot>>)`](crate::operation::describe_serverless_cache_snapshots::DescribeServerlessCacheSnapshotsOutput::serverless_cache_snapshots): <p>The serverless caches snapshots associated with a given description request. Available for Valkey, Redis OSS and Serverless Memcached only.</p>
15 /// - On failure, responds with [`SdkError<DescribeServerlessCacheSnapshotsError>`](crate::operation::describe_serverless_cache_snapshots::DescribeServerlessCacheSnapshotsError)
16 pub fn describe_serverless_cache_snapshots(
17 &self,
18 ) -> crate::operation::describe_serverless_cache_snapshots::builders::DescribeServerlessCacheSnapshotsFluentBuilder {
19 crate::operation::describe_serverless_cache_snapshots::builders::DescribeServerlessCacheSnapshotsFluentBuilder::new(self.handle.clone())
20 }
21}