You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::ElasticBeanstalk::Types::DescribeEnvironmentsMessage

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing DescribeEnvironmentsMessage as input to an Aws::Client method, you can use a vanilla 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",
}

Request to describe one or more environments.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#application_name ⇒ String

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

Returns:

  • (String) —

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

#environment_ids ⇒ Array<String>

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

Returns:

  • (Array<String>) —

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

#environment_names ⇒ Array<String>

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

Returns:

  • (Array<String>) —

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

#include_deleted ⇒ Boolean

Indicates whether to include deleted environments:

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

false: Do not include deleted environments.

Returns:

  • (Boolean) —

    Indicates whether to include deleted environments:.

#included_deleted_back_to ⇒ Time

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

Returns:

  • (Time) —

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

#max_records ⇒ Integer

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.

Returns:

  • (Integer) —

    For a paginated request.

#next_token ⇒ 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.

Returns:

  • (String) —

    For a paginated request.

#version_label ⇒ String

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

Returns:

  • (String) —

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