aws_sdk_databasemigration/client/
describe_connections.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 [`DescribeConnections`](crate::operation::describe_connections::builders::DescribeConnectionsFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_connections::builders::DescribeConnectionsFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`filters(Filter)`](crate::operation::describe_connections::builders::DescribeConnectionsFluentBuilder::filters) / [`set_filters(Option<Vec::<Filter>>)`](crate::operation::describe_connections::builders::DescribeConnectionsFluentBuilder::set_filters):<br>required: **false**<br><p>The filters applied to the connection.</p> <p>Valid filter names: endpoint-arn | replication-instance-arn</p><br>
    ///   - [`max_records(i32)`](crate::operation::describe_connections::builders::DescribeConnectionsFluentBuilder::max_records) / [`set_max_records(Option<i32>)`](crate::operation::describe_connections::builders::DescribeConnectionsFluentBuilder::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> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p><br>
    ///   - [`marker(impl Into<String>)`](crate::operation::describe_connections::builders::DescribeConnectionsFluentBuilder::marker) / [`set_marker(Option<String>)`](crate::operation::describe_connections::builders::DescribeConnectionsFluentBuilder::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>
    /// - On success, responds with [`DescribeConnectionsOutput`](crate::operation::describe_connections::DescribeConnectionsOutput) with field(s):
    ///   - [`marker(Option<String>)`](crate::operation::describe_connections::DescribeConnectionsOutput::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>
    ///   - [`connections(Option<Vec::<Connection>>)`](crate::operation::describe_connections::DescribeConnectionsOutput::connections): <p>A description of the connections.</p>
    /// - On failure, responds with [`SdkError<DescribeConnectionsError>`](crate::operation::describe_connections::DescribeConnectionsError)
    pub fn describe_connections(&self) -> crate::operation::describe_connections::builders::DescribeConnectionsFluentBuilder {
        crate::operation::describe_connections::builders::DescribeConnectionsFluentBuilder::new(self.handle.clone())
    }
}