class Aws::ElasticBeanstalk::Types::DescribeEnvironmentsMessage

Request to describe one or more environments.

@note When making an API call, you may pass DescribeEnvironmentsMessage

data as a hash:

    {
      application_name: "ApplicationName",
      version_label: "VersionLabel",
      environment_ids: ["EnvironmentId"],
      environment_names: ["EnvironmentName"],
      include_deleted: false,
      included_deleted_back_to: Time.now,
      max_records: 1,
      next_token: "Token",
    }

@!attribute [rw] application_name

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

@!attribute [rw] version_label

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

@!attribute [rw] environment_ids

If specified, AWS Elastic Beanstalk restricts the returned
descriptions to include only those that have the specified IDs.
@return [Array<String>]

@!attribute [rw] environment_names

If specified, AWS Elastic Beanstalk restricts the returned
descriptions to include only those that have the specified names.
@return [Array<String>]

@!attribute [rw] include_deleted

Indicates whether to include deleted environments:

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

`false`\: Do not include deleted environments.
@return [Boolean]

@!attribute [rw] included_deleted_back_to

If specified when `IncludeDeleted` is set to `true`, then
environments deleted after this date are displayed.
@return [Time]

@!attribute [rw] max_records

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.
@return [Integer]

@!attribute [rw] next_token

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.
@return [String]

@see docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/DescribeEnvironmentsMessage AWS API Documentation

Constants

SENSITIVE