aws_sdk_elasticache/client/
describe_replication_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 [`DescribeReplicationGroups`](crate::operation::describe_replication_groups::builders::DescribeReplicationGroupsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_replication_groups::builders::DescribeReplicationGroupsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`replication_group_id(impl Into<String>)`](crate::operation::describe_replication_groups::builders::DescribeReplicationGroupsFluentBuilder::replication_group_id) / [`set_replication_group_id(Option<String>)`](crate::operation::describe_replication_groups::builders::DescribeReplicationGroupsFluentBuilder::set_replication_group_id):<br>required: **false**<br><p>The identifier for the replication group to be described. This parameter is not case sensitive.</p> <p>If you do not specify this parameter, information about all replication groups is returned.</p><br>
8    ///   - [`max_records(i32)`](crate::operation::describe_replication_groups::builders::DescribeReplicationGroupsFluentBuilder::max_records) / [`set_max_records(Option<i32>)`](crate::operation::describe_replication_groups::builders::DescribeReplicationGroupsFluentBuilder::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 marker is included in the response so that the remaining results can be retrieved.</p> <p>Default: 100</p> <p>Constraints: minimum 20; maximum 100.</p><br>
9    ///   - [`marker(impl Into<String>)`](crate::operation::describe_replication_groups::builders::DescribeReplicationGroupsFluentBuilder::marker) / [`set_marker(Option<String>)`](crate::operation::describe_replication_groups::builders::DescribeReplicationGroupsFluentBuilder::set_marker):<br>required: **false**<br><p>An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p><br>
10    /// - On success, responds with [`DescribeReplicationGroupsOutput`](crate::operation::describe_replication_groups::DescribeReplicationGroupsOutput) with field(s):
11    ///   - [`marker(Option<String>)`](crate::operation::describe_replication_groups::DescribeReplicationGroupsOutput::marker): <p>Provides an identifier to allow retrieval of paginated results.</p>
12    ///   - [`replication_groups(Option<Vec::<ReplicationGroup>>)`](crate::operation::describe_replication_groups::DescribeReplicationGroupsOutput::replication_groups): <p>A list of replication groups. Each item in the list contains detailed information about one replication group.</p>
13    /// - On failure, responds with [`SdkError<DescribeReplicationGroupsError>`](crate::operation::describe_replication_groups::DescribeReplicationGroupsError)
14    pub fn describe_replication_groups(&self) -> crate::operation::describe_replication_groups::builders::DescribeReplicationGroupsFluentBuilder {
15        crate::operation::describe_replication_groups::builders::DescribeReplicationGroupsFluentBuilder::new(self.handle.clone())
16    }
17}
aws_sdk_elasticache/client/describe_replication_groups.rs

aws_sdk_elasticache/client/
describe_replication_groups.rs
