aws_sdk_opensearch/client/
describe_outbound_connections.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 [`DescribeOutboundConnections`](crate::operation::describe_outbound_connections::builders::DescribeOutboundConnectionsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_outbound_connections::builders::DescribeOutboundConnectionsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`filters(Filter)`](crate::operation::describe_outbound_connections::builders::DescribeOutboundConnectionsFluentBuilder::filters) / [`set_filters(Option<Vec::<Filter>>)`](crate::operation::describe_outbound_connections::builders::DescribeOutboundConnectionsFluentBuilder::set_filters):<br>required: **false**<br><p>List of filter names and values that you can use for requests.</p><br>
8    ///   - [`max_results(i32)`](crate::operation::describe_outbound_connections::builders::DescribeOutboundConnectionsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::describe_outbound_connections::builders::DescribeOutboundConnectionsFluentBuilder::set_max_results):<br>required: **false**<br><p>An optional parameter that specifies the maximum number of results to return. You can use <code>nextToken</code> to get the next page of results.</p><br>
9    ///   - [`next_token(impl Into<String>)`](crate::operation::describe_outbound_connections::builders::DescribeOutboundConnectionsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::describe_outbound_connections::builders::DescribeOutboundConnectionsFluentBuilder::set_next_token):<br>required: **false**<br><p>If your initial <code>DescribeOutboundConnections</code> operation returns a <code>nextToken</code>, you can include the returned <code>nextToken</code> in subsequent <code>DescribeOutboundConnections</code> operations, which returns results in the next page.</p><br>
10    /// - On success, responds with [`DescribeOutboundConnectionsOutput`](crate::operation::describe_outbound_connections::DescribeOutboundConnectionsOutput) with field(s):
11    ///   - [`connections(Option<Vec::<OutboundConnection>>)`](crate::operation::describe_outbound_connections::DescribeOutboundConnectionsOutput::connections): <p>List of outbound connections that match the filter criteria.</p>
12    ///   - [`next_token(Option<String>)`](crate::operation::describe_outbound_connections::DescribeOutboundConnectionsOutput::next_token): <p>When <code>nextToken</code> is returned, there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.</p>
13    /// - On failure, responds with [`SdkError<DescribeOutboundConnectionsError>`](crate::operation::describe_outbound_connections::DescribeOutboundConnectionsError)
14    pub fn describe_outbound_connections(
15        &self,
16    ) -> crate::operation::describe_outbound_connections::builders::DescribeOutboundConnectionsFluentBuilder {
17        crate::operation::describe_outbound_connections::builders::DescribeOutboundConnectionsFluentBuilder::new(self.handle.clone())
18    }
19}