aws_sdk_rds/client/
describe_db_shard_groups.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 [`DescribeDBShardGroups`](crate::operation::describe_db_shard_groups::builders::DescribeDBShardGroupsFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`db_shard_group_identifier(impl Into<String>)`](crate::operation::describe_db_shard_groups::builders::DescribeDBShardGroupsFluentBuilder::db_shard_group_identifier) / [`set_db_shard_group_identifier(Option<String>)`](crate::operation::describe_db_shard_groups::builders::DescribeDBShardGroupsFluentBuilder::set_db_shard_group_identifier):<br>required: **false**<br><p>The user-supplied DB shard group identifier. If this parameter is specified, information for only the specific DB shard group is returned. This parameter isn't case-sensitive.</p> <p>Constraints:</p> <ul>  <li>   <p>If supplied, must match an existing DB shard group identifier.</p></li> </ul><br>
7    ///   - [`filters(Filter)`](crate::operation::describe_db_shard_groups::builders::DescribeDBShardGroupsFluentBuilder::filters) / [`set_filters(Option<Vec::<Filter>>)`](crate::operation::describe_db_shard_groups::builders::DescribeDBShardGroupsFluentBuilder::set_filters):<br>required: **false**<br><p>A filter that specifies one or more DB shard groups to describe.</p><br>
8    ///   - [`marker(impl Into<String>)`](crate::operation::describe_db_shard_groups::builders::DescribeDBShardGroupsFluentBuilder::marker) / [`set_marker(Option<String>)`](crate::operation::describe_db_shard_groups::builders::DescribeDBShardGroupsFluentBuilder::set_marker):<br>required: **false**<br><p>An optional pagination token provided by a previous <code>DescribeDBShardGroups</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>
9    ///   - [`max_records(i32)`](crate::operation::describe_db_shard_groups::builders::DescribeDBShardGroupsFluentBuilder::max_records) / [`set_max_records(Option<i32>)`](crate::operation::describe_db_shard_groups::builders::DescribeDBShardGroupsFluentBuilder::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 you can retrieve the remaining results.</p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100</p><br>
10    /// - On success, responds with [`DescribeDbShardGroupsOutput`](crate::operation::describe_db_shard_groups::DescribeDbShardGroupsOutput) with field(s):
11    ///   - [`db_shard_groups(Option<Vec::<DbShardGroup>>)`](crate::operation::describe_db_shard_groups::DescribeDbShardGroupsOutput::db_shard_groups): <p>Contains a list of DB shard groups for the user.</p>
12    ///   - [`marker(Option<String>)`](crate::operation::describe_db_shard_groups::DescribeDbShardGroupsOutput::marker): <p>A pagination token that can be used in a later <code>DescribeDBClusters</code> request.</p>
13    /// - On failure, responds with [`SdkError<DescribeDBShardGroupsError>`](crate::operation::describe_db_shard_groups::DescribeDBShardGroupsError)
14    pub fn describe_db_shard_groups(&self) -> crate::operation::describe_db_shard_groups::builders::DescribeDBShardGroupsFluentBuilder {
15        crate::operation::describe_db_shard_groups::builders::DescribeDBShardGroupsFluentBuilder::new(self.handle.clone())
16    }
17}
aws_sdk_rds/client/describe_db_shard_groups.rs

aws_sdk_rds/client/
describe_db_shard_groups.rs
