aws_sdk_evs/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    ///   - [`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 unique pagination token for each page. If <code>nextToken</code> is returned, there are more results available. Make the call again using the returned token with all other arguments unchanged to retrieve the next page. Each pagination token expires after 24 hours. Using an expired pagination token will return an <i>HTTP 400 InvalidToken</i> error.</p><br>
8    ///   - [`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 maximum number of results to return. If you specify <code>MaxResults</code> in the request, the response includes information up to the limit specified.</p><br>
9    ///   - [`state(EnvironmentState)`](crate::operation::list_environments::builders::ListEnvironmentsFluentBuilder::state) / [`set_state(Option<Vec::<EnvironmentState>>)`](crate::operation::list_environments::builders::ListEnvironmentsFluentBuilder::set_state):<br>required: **false**<br><p>The state of an environment. Used to filter response results to return only environments with the specified <code>environmentState</code>.</p><br>
10    /// - On success, responds with [`ListEnvironmentsOutput`](crate::operation::list_environments::ListEnvironmentsOutput) with field(s):
11    ///   - [`next_token(Option<String>)`](crate::operation::list_environments::ListEnvironmentsOutput::next_token): <p>A unique pagination token for next page results. Make the call again using this token to retrieve the next page.</p>
12    ///   - [`environment_summaries(Option<Vec::<EnvironmentSummary>>)`](crate::operation::list_environments::ListEnvironmentsOutput::environment_summaries): <p>A list of environments with summarized environment details.</p>
13    /// - On failure, responds with [`SdkError<ListEnvironmentsError>`](crate::operation::list_environments::ListEnvironmentsError)
14    pub fn list_environments(&self) -> crate::operation::list_environments::builders::ListEnvironmentsFluentBuilder {
15        crate::operation::list_environments::builders::ListEnvironmentsFluentBuilder::new(self.handle.clone())
16    }
17}
aws_sdk_evs/client/list_environments.rs

aws_sdk_evs/client/
list_environments.rs
