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
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListEnvironments`](crate::operation::list_environments::builders::ListEnvironmentsFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_environments::builders::ListEnvironmentsFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`max_results(i32)`](crate::operation::list_environments::builders::ListEnvironmentsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_environments::builders::ListEnvironmentsFluentBuilder::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_environments::builders::ListEnvironmentsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_environments::builders::ListEnvironmentsFluentBuilder::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>
    ///   - [`provider(Provider)`](crate::operation::list_environments::builders::ListEnvironmentsFluentBuilder::provider) / [`set_provider(Option<Provider>)`](crate::operation::list_environments::builders::ListEnvironmentsFluentBuilder::set_provider):<br>required: **false**<br><p>Filter results to only include <code>Environment</code> objects that connect to the <code>Provider</code>.</p><br>
    ///   - [`location(impl Into<String>)`](crate::operation::list_environments::builders::ListEnvironmentsFluentBuilder::location) / [`set_location(Option<String>)`](crate::operation::list_environments::builders::ListEnvironmentsFluentBuilder::set_location):<br>required: **false**<br><p>Filter results to only include <code>Environment</code> objects that connect to a given location distiguisher.</p><br>
    /// - On success, responds with [`ListEnvironmentsOutput`](crate::operation::list_environments::ListEnvironmentsOutput) with field(s):
    ///   - [`environments(Vec::<Environment>)`](crate::operation::list_environments::ListEnvironmentsOutput::environments): <p>The list of matching <code>Environment</code> objects.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::list_environments::ListEnvironmentsOutput::next_token): <p>A pagination token for use in subsequent calls to fetch the next page of results.</p>
    /// - On failure, responds with [`SdkError<ListEnvironmentsError>`](crate::operation::list_environments::ListEnvironmentsError)
    pub fn list_environments(&self) -> crate::operation::list_environments::builders::ListEnvironmentsFluentBuilder {
        crate::operation::list_environments::builders::ListEnvironmentsFluentBuilder::new(self.handle.clone())
    }
}