aws_sdk_rds/client/
describe_db_shard_groups.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeDBShardGroups`](crate::operation::describe_db_shard_groups::builders::DescribeDBShardGroupsFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`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 or the Amazon Resource Name (ARN) of the DB shard group. 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>
    ///   - [`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>
    ///   - [`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>
    ///   - [`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>
    /// - On success, responds with [`DescribeDbShardGroupsOutput`](crate::operation::describe_db_shard_groups::DescribeDbShardGroupsOutput) with field(s):
    ///   - [`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>
    ///   - [`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>
    /// - On failure, responds with [`SdkError<DescribeDBShardGroupsError>`](crate::operation::describe_db_shard_groups::DescribeDBShardGroupsError)
    pub fn describe_db_shard_groups(&self) -> crate::operation::describe_db_shard_groups::builders::DescribeDBShardGroupsFluentBuilder {
        crate::operation::describe_db_shard_groups::builders::DescribeDBShardGroupsFluentBuilder::new(self.handle.clone())
    }
}