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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb

Overview

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",
}

Request to describe one or more environments.

Instance Attribute Summary collapse

Instance Attribute Details

#application_nameString

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

Returns:

  • (String)


2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 2097

class DescribeEnvironmentsMessage < Struct.new(
  :application_name,
  :version_label,
  :environment_ids,
  :environment_names,
  :include_deleted,
  :included_deleted_back_to,
  :max_records,
  :next_token)
  include Aws::Structure
end

#environment_idsArray<String>

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

Returns:

  • (Array<String>)


2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 2097

class DescribeEnvironmentsMessage < Struct.new(
  :application_name,
  :version_label,
  :environment_ids,
  :environment_names,
  :include_deleted,
  :included_deleted_back_to,
  :max_records,
  :next_token)
  include Aws::Structure
end

#environment_namesArray<String>

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

Returns:

  • (Array<String>)


2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 2097

class DescribeEnvironmentsMessage < Struct.new(
  :application_name,
  :version_label,
  :environment_ids,
  :environment_names,
  :include_deleted,
  :included_deleted_back_to,
  :max_records,
  :next_token)
  include Aws::Structure
end

#include_deletedBoolean

Indicates whether to include deleted environments:

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

false: Do not include deleted environments.

Returns:

  • (Boolean)


2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 2097

class DescribeEnvironmentsMessage < Struct.new(
  :application_name,
  :version_label,
  :environment_ids,
  :environment_names,
  :include_deleted,
  :included_deleted_back_to,
  :max_records,
  :next_token)
  include Aws::Structure
end

#included_deleted_back_toTime

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

Returns:

  • (Time)


2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 2097

class DescribeEnvironmentsMessage < Struct.new(
  :application_name,
  :version_label,
  :environment_ids,
  :environment_names,
  :include_deleted,
  :included_deleted_back_to,
  :max_records,
  :next_token)
  include Aws::Structure
end

#max_recordsInteger

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)


2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 2097

class DescribeEnvironmentsMessage < Struct.new(
  :application_name,
  :version_label,
  :environment_ids,
  :environment_names,
  :include_deleted,
  :included_deleted_back_to,
  :max_records,
  :next_token)
  include Aws::Structure
end

#next_tokenString

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)


2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 2097

class DescribeEnvironmentsMessage < Struct.new(
  :application_name,
  :version_label,
  :environment_ids,
  :environment_names,
  :include_deleted,
  :included_deleted_back_to,
  :max_records,
  :next_token)
  include Aws::Structure
end

#version_labelString

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

Returns:

  • (String)


2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 2097

class DescribeEnvironmentsMessage < Struct.new(
  :application_name,
  :version_label,
  :environment_ids,
  :environment_names,
  :include_deleted,
  :included_deleted_back_to,
  :max_records,
  :next_token)
  include Aws::Structure
end