aws_sdk_databasemigration/client/describe_replications.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 [`DescribeReplications`](crate::operation::describe_replications::builders::DescribeReplicationsFluentBuilder) operation.
4 /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_replications::builders::DescribeReplicationsFluentBuilder::into_paginator).
5 ///
6 /// - The fluent builder is configurable:
7 /// - [`filters(Filter)`](crate::operation::describe_replications::builders::DescribeReplicationsFluentBuilder::filters) / [`set_filters(Option<Vec::<Filter>>)`](crate::operation::describe_replications::builders::DescribeReplicationsFluentBuilder::set_filters):<br>required: **false**<br><p>Filters applied to the replications.</p> <p>Valid filter names: <code>replication-config-arn</code> | <code>replication-config-id</code></p><br>
8 /// - [`max_records(i32)`](crate::operation::describe_replications::builders::DescribeReplicationsFluentBuilder::max_records) / [`set_max_records(Option<i32>)`](crate::operation::describe_replications::builders::DescribeReplicationsFluentBuilder::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 the remaining results can be retrieved.</p><br>
9 /// - [`marker(impl Into<String>)`](crate::operation::describe_replications::builders::DescribeReplicationsFluentBuilder::marker) / [`set_marker(Option<String>)`](crate::operation::describe_replications::builders::DescribeReplicationsFluentBuilder::set_marker):<br>required: **false**<br><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><br>
10 /// - On success, responds with [`DescribeReplicationsOutput`](crate::operation::describe_replications::DescribeReplicationsOutput) with field(s):
11 /// - [`marker(Option<String>)`](crate::operation::describe_replications::DescribeReplicationsOutput::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>
12 /// - [`replications(Option<Vec::<Replication>>)`](crate::operation::describe_replications::DescribeReplicationsOutput::replications): <p>The replication descriptions.</p>
13 /// - On failure, responds with [`SdkError<DescribeReplicationsError>`](crate::operation::describe_replications::DescribeReplicationsError)
14 pub fn describe_replications(&self) -> crate::operation::describe_replications::builders::DescribeReplicationsFluentBuilder {
15 crate::operation::describe_replications::builders::DescribeReplicationsFluentBuilder::new(self.handle.clone())
16 }
17}