aws_sdk_rds/client/
describe_db_parameters.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeDBParameters`](crate::operation::describe_db_parameters::builders::DescribeDBParametersFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_db_parameters::builders::DescribeDBParametersFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`db_parameter_group_name(impl Into<String>)`](crate::operation::describe_db_parameters::builders::DescribeDBParametersFluentBuilder::db_parameter_group_name) / [`set_db_parameter_group_name(Option<String>)`](crate::operation::describe_db_parameters::builders::DescribeDBParametersFluentBuilder::set_db_parameter_group_name):<br>required: **true**<br><p>The name of a specific DB parameter group to return details for.</p> <p>Constraints:</p> <ul>  <li>   <p>If supplied, must match the name of an existing DBParameterGroup.</p></li> </ul><br>
    ///   - [`source(impl Into<String>)`](crate::operation::describe_db_parameters::builders::DescribeDBParametersFluentBuilder::source) / [`set_source(Option<String>)`](crate::operation::describe_db_parameters::builders::DescribeDBParametersFluentBuilder::set_source):<br>required: **false**<br><p>The parameter types to return.</p> <p>Default: All parameter types returned</p> <p>Valid Values: <code>user | system | engine-default</code></p><br>
    ///   - [`filters(Filter)`](crate::operation::describe_db_parameters::builders::DescribeDBParametersFluentBuilder::filters) / [`set_filters(Option<Vec::<Filter>>)`](crate::operation::describe_db_parameters::builders::DescribeDBParametersFluentBuilder::set_filters):<br>required: **false**<br><p>This parameter isn't currently supported.</p><br>
    ///   - [`max_records(i32)`](crate::operation::describe_db_parameters::builders::DescribeDBParametersFluentBuilder::max_records) / [`set_max_records(Option<i32>)`](crate::operation::describe_db_parameters::builders::DescribeDBParametersFluentBuilder::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 pagination token called a marker is included in the response so that you can retrieve the remaining results.</p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p><br>
    ///   - [`marker(impl Into<String>)`](crate::operation::describe_db_parameters::builders::DescribeDBParametersFluentBuilder::marker) / [`set_marker(Option<String>)`](crate::operation::describe_db_parameters::builders::DescribeDBParametersFluentBuilder::set_marker):<br>required: **false**<br><p>An optional pagination token provided by a previous <code>DescribeDBParameters</code> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p><br>
    /// - On success, responds with [`DescribeDbParametersOutput`](crate::operation::describe_db_parameters::DescribeDbParametersOutput) with field(s):
    ///   - [`parameters(Option<Vec::<Parameter>>)`](crate::operation::describe_db_parameters::DescribeDbParametersOutput::parameters): <p>A list of <code>Parameter</code> values.</p>
    ///   - [`marker(Option<String>)`](crate::operation::describe_db_parameters::DescribeDbParametersOutput::marker): <p>An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>
    /// - On failure, responds with [`SdkError<DescribeDBParametersError>`](crate::operation::describe_db_parameters::DescribeDBParametersError)
    pub fn describe_db_parameters(&self) -> crate::operation::describe_db_parameters::builders::DescribeDBParametersFluentBuilder {
        crate::operation::describe_db_parameters::builders::DescribeDBParametersFluentBuilder::new(self.handle.clone())
    }
}