aws_sdk_proton/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 token that indicates the location of the next environment in the array of environments, after the list of environments that was previously requested.</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 environments to list.</p><br>
9    ///   - [`environment_templates(EnvironmentTemplateFilter)`](crate::operation::list_environments::builders::ListEnvironmentsFluentBuilder::environment_templates) / [`set_environment_templates(Option<Vec::<EnvironmentTemplateFilter>>)`](crate::operation::list_environments::builders::ListEnvironmentsFluentBuilder::set_environment_templates):<br>required: **false**<br><p>An array of the versions of the environment template.</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 token that indicates the location of the next environment in the array of environments, after the current requested list of environments.</p>
12    ///   - [`environments(Vec::<EnvironmentSummary>)`](crate::operation::list_environments::ListEnvironmentsOutput::environments): <p>An array of environment detail data summaries.</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}