aws_sdk_elasticache/client/
describe_cache_parameters.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 [`DescribeCacheParameters`](crate::operation::describe_cache_parameters::builders::DescribeCacheParametersFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_cache_parameters::builders::DescribeCacheParametersFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`cache_parameter_group_name(impl Into<String>)`](crate::operation::describe_cache_parameters::builders::DescribeCacheParametersFluentBuilder::cache_parameter_group_name) / [`set_cache_parameter_group_name(Option<String>)`](crate::operation::describe_cache_parameters::builders::DescribeCacheParametersFluentBuilder::set_cache_parameter_group_name):<br>required: **true**<br><p>The name of a specific cache parameter group to return details for.</p><br>
8    ///   - [`source(impl Into<String>)`](crate::operation::describe_cache_parameters::builders::DescribeCacheParametersFluentBuilder::source) / [`set_source(Option<String>)`](crate::operation::describe_cache_parameters::builders::DescribeCacheParametersFluentBuilder::set_source):<br>required: **false**<br><p>The parameter types to return.</p> <p>Valid values: <code>user</code> | <code>system</code> | <code>engine-default</code></p><br>
9    ///   - [`max_records(i32)`](crate::operation::describe_cache_parameters::builders::DescribeCacheParametersFluentBuilder::max_records) / [`set_max_records(Option<i32>)`](crate::operation::describe_cache_parameters::builders::DescribeCacheParametersFluentBuilder::set_max_records):<br>required: **false**<br><p>The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a marker is included in the response so that the remaining results can be retrieved.</p> <p>Default: 100</p> <p>Constraints: minimum 20; maximum 100.</p><br>
10    ///   - [`marker(impl Into<String>)`](crate::operation::describe_cache_parameters::builders::DescribeCacheParametersFluentBuilder::marker) / [`set_marker(Option<String>)`](crate::operation::describe_cache_parameters::builders::DescribeCacheParametersFluentBuilder::set_marker):<br>required: **false**<br><p>An optional marker returned from a prior request. Use this marker for 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 <code>MaxRecords</code>.</p><br>
11    /// - On success, responds with [`DescribeCacheParametersOutput`](crate::operation::describe_cache_parameters::DescribeCacheParametersOutput) with field(s):
12    ///   - [`marker(Option<String>)`](crate::operation::describe_cache_parameters::DescribeCacheParametersOutput::marker): <p>Provides an identifier to allow retrieval of paginated results.</p>
13    ///   - [`parameters(Option<Vec::<Parameter>>)`](crate::operation::describe_cache_parameters::DescribeCacheParametersOutput::parameters): <p>A list of <code>Parameter</code> instances.</p>
14    ///   - [`cache_node_type_specific_parameters(Option<Vec::<CacheNodeTypeSpecificParameter>>)`](crate::operation::describe_cache_parameters::DescribeCacheParametersOutput::cache_node_type_specific_parameters): <p>A list of parameters specific to a particular cache node type. Each element in the list contains detailed information about one parameter.</p>
15    /// - On failure, responds with [`SdkError<DescribeCacheParametersError>`](crate::operation::describe_cache_parameters::DescribeCacheParametersError)
16    pub fn describe_cache_parameters(&self) -> crate::operation::describe_cache_parameters::builders::DescribeCacheParametersFluentBuilder {
17        crate::operation::describe_cache_parameters::builders::DescribeCacheParametersFluentBuilder::new(self.handle.clone())
18    }
19}