aws_sdk_interconnect/client/list_environments.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 [`ListEnvironments`](crate::operation::list_environments::builders::ListEnvironmentsFluentBuilder) operation.
4 /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_environments::builders::ListEnvironmentsFluentBuilder::into_paginator).
5 ///
6 /// - The fluent builder is configurable:
7 /// - [`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>
8 /// - [`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>
9 /// - [`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>
10 /// - [`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>
11 /// - On success, responds with [`ListEnvironmentsOutput`](crate::operation::list_environments::ListEnvironmentsOutput) with field(s):
12 /// - [`environments(Vec::<Environment>)`](crate::operation::list_environments::ListEnvironmentsOutput::environments): <p>The list of matching <code>Environment</code> objects.</p>
13 /// - [`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>
14 /// - On failure, responds with [`SdkError<ListEnvironmentsError>`](crate::operation::list_environments::ListEnvironmentsError)
15 pub fn list_environments(&self) -> crate::operation::list_environments::builders::ListEnvironmentsFluentBuilder {
16 crate::operation::list_environments::builders::ListEnvironmentsFluentBuilder::new(self.handle.clone())
17 }
18}