aws-sdk-interconnect 1.1.0

AWS SDK for Interconnect
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListConnections`](crate::operation::list_connections::builders::ListConnectionsFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_connections::builders::ListConnectionsFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`max_results(i32)`](crate::operation::list_connections::builders::ListConnectionsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_connections::builders::ListConnectionsFluentBuilder::set_max_results):<br>required: **false**<br><p>The max number of list results in a single paginated response.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::list_connections::builders::ListConnectionsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_connections::builders::ListConnectionsFluentBuilder::set_next_token):<br>required: **false**<br><p>A pagination token from a previous paginated response indicating you wish to get the next page of results.</p><br>
    ///   - [`state(ConnectionState)`](crate::operation::list_connections::builders::ListConnectionsFluentBuilder::state) / [`set_state(Option<ConnectionState>)`](crate::operation::list_connections::builders::ListConnectionsFluentBuilder::set_state):<br>required: **false**<br><p>Filter the results to only include <code>Connection</code> objects in the given <code>Connection$state</code>.</p><br>
    ///   - [`environment_id(impl Into<String>)`](crate::operation::list_connections::builders::ListConnectionsFluentBuilder::environment_id) / [`set_environment_id(Option<String>)`](crate::operation::list_connections::builders::ListConnectionsFluentBuilder::set_environment_id):<br>required: **false**<br><p>Filter the results to only include <code>Connection</code> objects on the given <code>Environment</code>.</p><br>
    ///   - [`provider(Provider)`](crate::operation::list_connections::builders::ListConnectionsFluentBuilder::provider) / [`set_provider(Option<Provider>)`](crate::operation::list_connections::builders::ListConnectionsFluentBuilder::set_provider):<br>required: **false**<br><p>Filter the results to only include <code>Connection</code> objects to the given <code>Provider</code>.</p><br>
    ///   - [`attach_point(AttachPoint)`](crate::operation::list_connections::builders::ListConnectionsFluentBuilder::attach_point) / [`set_attach_point(Option<AttachPoint>)`](crate::operation::list_connections::builders::ListConnectionsFluentBuilder::set_attach_point):<br>required: **false**<br><p>Filter results to only include <code>Connection</code> objects attached to the given <code>AttachPoint</code>.</p><br>
    /// - On success, responds with [`ListConnectionsOutput`](crate::operation::list_connections::ListConnectionsOutput) with field(s):
    ///   - [`connections(Option<Vec::<ConnectionSummary>>)`](crate::operation::list_connections::ListConnectionsOutput::connections): <p>The resulting list of <code>Connection</code> objects.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::list_connections::ListConnectionsOutput::next_token): <p>A pagination token for use in subsequent calls to fetch the next page of results.</p>
    /// - On failure, responds with [`SdkError<ListConnectionsError>`](crate::operation::list_connections::ListConnectionsError)
    pub fn list_connections(&self) -> crate::operation::list_connections::builders::ListConnectionsFluentBuilder {
        crate::operation::list_connections::builders::ListConnectionsFluentBuilder::new(self.handle.clone())
    }
}