aws_sdk_rds/client/
describe_option_groups.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeOptionGroups`](crate::operation::describe_option_groups::builders::DescribeOptionGroupsFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_option_groups::builders::DescribeOptionGroupsFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`option_group_name(impl Into<String>)`](crate::operation::describe_option_groups::builders::DescribeOptionGroupsFluentBuilder::option_group_name) / [`set_option_group_name(Option<String>)`](crate::operation::describe_option_groups::builders::DescribeOptionGroupsFluentBuilder::set_option_group_name):<br>required: **false**<br><p>The name of the option group to describe. Can't be supplied together with EngineName or MajorEngineVersion.</p><br>
    ///   - [`filters(Filter)`](crate::operation::describe_option_groups::builders::DescribeOptionGroupsFluentBuilder::filters) / [`set_filters(Option<Vec::<Filter>>)`](crate::operation::describe_option_groups::builders::DescribeOptionGroupsFluentBuilder::set_filters):<br>required: **false**<br><p>This parameter isn't currently supported.</p><br>
    ///   - [`marker(impl Into<String>)`](crate::operation::describe_option_groups::builders::DescribeOptionGroupsFluentBuilder::marker) / [`set_marker(Option<String>)`](crate::operation::describe_option_groups::builders::DescribeOptionGroupsFluentBuilder::set_marker):<br>required: **false**<br><p>An optional pagination token provided by a previous DescribeOptionGroups 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>
    ///   - [`max_records(i32)`](crate::operation::describe_option_groups::builders::DescribeOptionGroupsFluentBuilder::max_records) / [`set_max_records(Option<i32>)`](crate::operation::describe_option_groups::builders::DescribeOptionGroupsFluentBuilder::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>
    ///   - [`engine_name(impl Into<String>)`](crate::operation::describe_option_groups::builders::DescribeOptionGroupsFluentBuilder::engine_name) / [`set_engine_name(Option<String>)`](crate::operation::describe_option_groups::builders::DescribeOptionGroupsFluentBuilder::set_engine_name):<br>required: **false**<br><p>A filter to only include option groups associated with this database engine.</p> <p>Valid Values:</p> <ul>  <li>   <p><code>db2-ae</code></p></li>  <li>   <p><code>db2-se</code></p></li>  <li>   <p><code>mariadb</code></p></li>  <li>   <p><code>mysql</code></p></li>  <li>   <p><code>oracle-ee</code></p></li>  <li>   <p><code>oracle-ee-cdb</code></p></li>  <li>   <p><code>oracle-se2</code></p></li>  <li>   <p><code>oracle-se2-cdb</code></p></li>  <li>   <p><code>postgres</code></p></li>  <li>   <p><code>sqlserver-ee</code></p></li>  <li>   <p><code>sqlserver-se</code></p></li>  <li>   <p><code>sqlserver-ex</code></p></li>  <li>   <p><code>sqlserver-web</code></p></li> </ul><br>
    ///   - [`major_engine_version(impl Into<String>)`](crate::operation::describe_option_groups::builders::DescribeOptionGroupsFluentBuilder::major_engine_version) / [`set_major_engine_version(Option<String>)`](crate::operation::describe_option_groups::builders::DescribeOptionGroupsFluentBuilder::set_major_engine_version):<br>required: **false**<br><p>Filters the list of option groups to only include groups associated with a specific database engine version. If specified, then EngineName must also be specified.</p><br>
    /// - On success, responds with [`DescribeOptionGroupsOutput`](crate::operation::describe_option_groups::DescribeOptionGroupsOutput) with field(s):
    ///   - [`option_groups_list(Option<Vec::<OptionGroup>>)`](crate::operation::describe_option_groups::DescribeOptionGroupsOutput::option_groups_list): <p>List of option groups.</p>
    ///   - [`marker(Option<String>)`](crate::operation::describe_option_groups::DescribeOptionGroupsOutput::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<DescribeOptionGroupsError>`](crate::operation::describe_option_groups::DescribeOptionGroupsError)
    pub fn describe_option_groups(&self) -> crate::operation::describe_option_groups::builders::DescribeOptionGroupsFluentBuilder {
        crate::operation::describe_option_groups::builders::DescribeOptionGroupsFluentBuilder::new(self.handle.clone())
    }
}