1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeEnvironments`](crate::operation::describe_environments::builders::DescribeEnvironmentsFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`application_name(impl ::std::convert::Into<String>)`](crate::operation::describe_environments::builders::DescribeEnvironmentsFluentBuilder::application_name) / [`set_application_name(Option<String>)`](crate::operation::describe_environments::builders::DescribeEnvironmentsFluentBuilder::set_application_name): <p>If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application.</p>
    ///   - [`version_label(impl ::std::convert::Into<String>)`](crate::operation::describe_environments::builders::DescribeEnvironmentsFluentBuilder::version_label) / [`set_version_label(Option<String>)`](crate::operation::describe_environments::builders::DescribeEnvironmentsFluentBuilder::set_version_label): <p>If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version.</p>
    ///   - [`environment_ids(Vec<String>)`](crate::operation::describe_environments::builders::DescribeEnvironmentsFluentBuilder::environment_ids) / [`set_environment_ids(Option<Vec<String>>)`](crate::operation::describe_environments::builders::DescribeEnvironmentsFluentBuilder::set_environment_ids): <p>If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.</p>
    ///   - [`environment_names(Vec<String>)`](crate::operation::describe_environments::builders::DescribeEnvironmentsFluentBuilder::environment_names) / [`set_environment_names(Option<Vec<String>>)`](crate::operation::describe_environments::builders::DescribeEnvironmentsFluentBuilder::set_environment_names): <p>If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.</p>
    ///   - [`include_deleted(bool)`](crate::operation::describe_environments::builders::DescribeEnvironmentsFluentBuilder::include_deleted) / [`set_include_deleted(Option<bool>)`](crate::operation::describe_environments::builders::DescribeEnvironmentsFluentBuilder::set_include_deleted): <p>Indicates whether to include deleted environments:</p>  <p> <code>true</code>: Environments that have been deleted after <code>IncludedDeletedBackTo</code> are displayed.</p>  <p> <code>false</code>: Do not include deleted environments.</p>
    ///   - [`included_deleted_back_to(DateTime)`](crate::operation::describe_environments::builders::DescribeEnvironmentsFluentBuilder::included_deleted_back_to) / [`set_included_deleted_back_to(Option<DateTime>)`](crate::operation::describe_environments::builders::DescribeEnvironmentsFluentBuilder::set_included_deleted_back_to): <p> If specified when <code>IncludeDeleted</code> is set to <code>true</code>, then environments deleted after this date are displayed. </p>
    ///   - [`max_records(i32)`](crate::operation::describe_environments::builders::DescribeEnvironmentsFluentBuilder::max_records) / [`set_max_records(Option<i32>)`](crate::operation::describe_environments::builders::DescribeEnvironmentsFluentBuilder::set_max_records): <p>For a paginated request. Specify a maximum number of environments to include in each response.</p>  <p>If no <code>MaxRecords</code> is specified, all available environments are retrieved in a single response.</p>
    ///   - [`next_token(impl ::std::convert::Into<String>)`](crate::operation::describe_environments::builders::DescribeEnvironmentsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::describe_environments::builders::DescribeEnvironmentsFluentBuilder::set_next_token): <p>For a paginated request. Specify a token from a previous response page to retrieve the next response page. All other parameter values must be identical to the ones specified in the initial request.</p>  <p>If no <code>NextToken</code> is specified, the first page is retrieved.</p>
    /// - On success, responds with [`DescribeEnvironmentsOutput`](crate::operation::describe_environments::DescribeEnvironmentsOutput) with field(s):
    ///   - [`environments(Option<Vec<EnvironmentDescription>>)`](crate::operation::describe_environments::DescribeEnvironmentsOutput::environments): <p> Returns an <code>EnvironmentDescription</code> list. </p>
    ///   - [`next_token(Option<String>)`](crate::operation::describe_environments::DescribeEnvironmentsOutput::next_token): <p>In a paginated request, the token that you can pass in a subsequent request to get the next response page.</p>
    /// - On failure, responds with [`SdkError<DescribeEnvironmentsError>`](crate::operation::describe_environments::DescribeEnvironmentsError)
    pub fn describe_environments(&self) -> crate::operation::describe_environments::builders::DescribeEnvironmentsFluentBuilder {
        crate::operation::describe_environments::builders::DescribeEnvironmentsFluentBuilder::new(self.handle.clone())
    }
}