Struct aws_sdk_elasticbeanstalk::client::fluent_builders::DescribeEnvironments

source · [−]

pub struct DescribeEnvironments<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* private fields */ }

Expand description

Fluent builder constructing a request to DescribeEnvironments.

Returns descriptions for existing environments.

Implementations

source

impl<C, M, R> DescribeEnvironments<C, M, R> where
 C: SmithyConnector,
 M: SmithyMiddleware<C>,
 R: NewRequestPolicy,

source

pub async fn send(
self
) -> Result<DescribeEnvironmentsOutput, SdkError<DescribeEnvironmentsError>> where
R::Policy: SmithyRetryPolicy<DescribeEnvironmentsInputOperationOutputAlias, DescribeEnvironmentsOutput, DescribeEnvironmentsError, DescribeEnvironmentsInputOperationRetryAlias>,

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

source

pub fn application_name(self, input: impl Into<String>) -> Self

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

source

pub fn set_application_name(self, input: Option<String>) -> Self

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

source

pub fn version_label(self, input: impl Into<String>) -> Self

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

source

pub fn set_version_label(self, input: Option<String>) -> Self

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

source

pub fn environment_ids(self, input: impl Into<String>) -> Self

Appends an item to EnvironmentIds.

To override the contents of this collection use set_environment_ids.

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

source

pub fn set_environment_ids(self, input: Option<Vec<String>>) -> Self

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

source

pub fn environment_names(self, input: impl Into<String>) -> Self

Appends an item to EnvironmentNames.

To override the contents of this collection use set_environment_names.

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

source

pub fn set_environment_names(self, input: Option<Vec<String>>) -> Self

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

source

pub fn include_deleted(self, input: bool) -> Self

Indicates whether to include deleted environments:

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

false: Do not include deleted environments.

source

pub fn set_include_deleted(self, input: Option<bool>) -> Self

Indicates whether to include deleted environments:

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

false: Do not include deleted environments.

source

pub fn included_deleted_back_to(self, input: DateTime) -> Self

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

source

pub fn set_included_deleted_back_to(self, input: Option<DateTime>) -> Self

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

source

pub fn max_records(self, input: i32) -> Self

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.

source

pub fn set_max_records(self, input: Option<i32>) -> Self

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.

source

pub fn next_token(self, input: impl Into<String>) -> Self

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.

source

pub fn set_next_token(self, input: Option<String>) -> Self

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.