Struct aws_sdk_elasticbeanstalk::operation::describe_environments::DescribeEnvironmentsInput

#[non_exhaustive]
pub struct DescribeEnvironmentsInput {
    pub application_name: Option<String>,
    pub version_label: Option<String>,
    pub environment_ids: Option<Vec<String>>,
    pub environment_names: Option<Vec<String>>,
    pub include_deleted: Option<bool>,
    pub included_deleted_back_to: Option<DateTime>,
    pub max_records: Option<i32>,
    pub next_token: Option<String>,
}

Request to describe one or more environments.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

application_name: Option<String>

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application.

version_label: Option<String>

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version.

environment_ids: Option<Vec<String>>

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.

environment_names: Option<Vec<String>>

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.

include_deleted: Option<bool>

Indicates whether to include deleted environments:

true: Environments that have been deleted after IncludedDeletedBackTo are displayed.

false: Do not include deleted environments.

included_deleted_back_to: Option<DateTime>

If specified when IncludeDeleted is set to true, then environments deleted after this date are displayed.

max_records: Option<i32>

For a paginated request. Specify a maximum number of environments to include in each response.

If no MaxRecords is specified, all available environments are retrieved in a single response.

next_token: Option<String>

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.

If no NextToken is specified, the first page is retrieved.

Implementations

impl DescribeEnvironmentsInput

pub fn application_name(&self) -> Option<&str>

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application.

pub fn version_label(&self) -> Option<&str>

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version.

pub fn environment_ids(&self) -> &[String]

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .environment_ids.is_none().

pub fn environment_names(&self) -> &[String]

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .environment_names.is_none().

pub fn include_deleted(&self) -> Option<bool>

Indicates whether to include deleted environments:

true: Environments that have been deleted after IncludedDeletedBackTo are displayed.

false: Do not include deleted environments.

pub fn included_deleted_back_to(&self) -> Option<&DateTime>

If specified when IncludeDeleted is set to true, then environments deleted after this date are displayed.

pub fn max_records(&self) -> Option<i32>

For a paginated request. Specify a maximum number of environments to include in each response.

If no MaxRecords is specified, all available environments are retrieved in a single response.

pub fn next_token(&self) -> Option<&str>

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.

If no NextToken is specified, the first page is retrieved.

impl DescribeEnvironmentsInput

pub fn builder() -> DescribeEnvironmentsInputBuilder

Creates a new builder-style object to manufacture DescribeEnvironmentsInput.

Trait Implementations

impl Clone for DescribeEnvironmentsInput

fn clone(&self) -> DescribeEnvironmentsInput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DescribeEnvironmentsInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for DescribeEnvironmentsInput

fn eq(&self, other: &DescribeEnvironmentsInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for DescribeEnvironmentsInput