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

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

Overview

Request to describe one or more environments.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

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) 


1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
 
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 1957

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

#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>) 


1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
 
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 1957

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

#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>) 


1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
 
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 1957

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

#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) 


1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
 
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 1957

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

#included_deleted_back_to ⇒ Time

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

Returns:

  • (Time) 


1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
 
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 1957

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

#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) 


1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
 
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 1957

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

#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) 


1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
 
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 1957

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

#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) 


1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
 
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 1957

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