aws_sdk_memorydb/client/
describe_multi_region_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 [`DescribeMultiRegionParameters`](crate::operation::describe_multi_region_parameters::builders::DescribeMultiRegionParametersFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`multi_region_parameter_group_name(impl Into<String>)`](crate::operation::describe_multi_region_parameters::builders::DescribeMultiRegionParametersFluentBuilder::multi_region_parameter_group_name) / [`set_multi_region_parameter_group_name(Option<String>)`](crate::operation::describe_multi_region_parameters::builders::DescribeMultiRegionParametersFluentBuilder::set_multi_region_parameter_group_name):<br>required: **true**<br><p>The name of the multi-region parameter group to return details for.</p><br>
7    ///   - [`source(impl Into<String>)`](crate::operation::describe_multi_region_parameters::builders::DescribeMultiRegionParametersFluentBuilder::source) / [`set_source(Option<String>)`](crate::operation::describe_multi_region_parameters::builders::DescribeMultiRegionParametersFluentBuilder::set_source):<br>required: **false**<br><p>The parameter types to return. Valid values: user | system | engine-default</p><br>
8    ///   - [`max_results(i32)`](crate::operation::describe_multi_region_parameters::builders::DescribeMultiRegionParametersFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::describe_multi_region_parameters::builders::DescribeMultiRegionParametersFluentBuilder::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 MaxResults value, a token is included in the response so that the remaining results can be retrieved.</p><br>
9    ///   - [`next_token(impl Into<String>)`](crate::operation::describe_multi_region_parameters::builders::DescribeMultiRegionParametersFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::describe_multi_region_parameters::builders::DescribeMultiRegionParametersFluentBuilder::set_next_token):<br>required: **false**<br><p>An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.</p><br>
10    /// - On success, responds with [`DescribeMultiRegionParametersOutput`](crate::operation::describe_multi_region_parameters::DescribeMultiRegionParametersOutput) with field(s):
11    ///   - [`next_token(Option<String>)`](crate::operation::describe_multi_region_parameters::DescribeMultiRegionParametersOutput::next_token): <p>An optional token to include in the response. If this token is provided, the response includes only results beyond the token, up to the value specified by MaxResults.</p>
12    ///   - [`multi_region_parameters(Option<Vec::<MultiRegionParameter>>)`](crate::operation::describe_multi_region_parameters::DescribeMultiRegionParametersOutput::multi_region_parameters): <p>A list of parameters specific to a particular multi-region parameter group. Each element in the list contains detailed information about one parameter.</p>
13    /// - On failure, responds with [`SdkError<DescribeMultiRegionParametersError>`](crate::operation::describe_multi_region_parameters::DescribeMultiRegionParametersError)
14    pub fn describe_multi_region_parameters(
15        &self,
16    ) -> crate::operation::describe_multi_region_parameters::builders::DescribeMultiRegionParametersFluentBuilder {
17        crate::operation::describe_multi_region_parameters::builders::DescribeMultiRegionParametersFluentBuilder::new(self.handle.clone())
18    }
19}