DescribeEnvironmentsRequest Class

Container for the parameters to the DescribeEnvironments operation. Returns descriptions for existing environments.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.ElasticBeanstalk.AmazonElasticBeanstalkRequest
      Amazon.ElasticBeanstalk.Model.DescribeEnvironmentsRequest

Namespace: Amazon.ElasticBeanstalk.Model
Assembly: AWSSDK.ElasticBeanstalk.dll
Version: 3.x.y.z

Syntax

public class DescribeEnvironmentsRequest : AmazonElasticBeanstalkRequest
         IAmazonWebServiceRequest

The DescribeEnvironmentsRequest type exposes the following members

Constructors

	Name	Description
	DescribeEnvironmentsRequest()	Empty constructor used to set properties independently even when a simple constructor is available

Properties

Name	Type	Description
ApplicationName	System.String	Gets and sets the property ApplicationName. If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application.
EnvironmentIds	System.Collections.Generic.List<System.String>	Gets and sets the property EnvironmentIds. If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.
EnvironmentNames	System.Collections.Generic.List<System.String>	Gets and sets the property EnvironmentNames. If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.
IncludedDeletedBackTo	System.DateTime	Gets and sets the property IncludedDeletedBackToUtc. This property is deprecated. Setting this property results in non-UTC DateTimes not being marshalled correctly. Use IncludedDeletedBackToUtc instead. Setting either IncludedDeletedBackTo or IncludedDeletedBackToUtc results in both IncludedDeletedBackTo and IncludedDeletedBackToUtc being assigned, the latest assignment to either one of the two property is reflected in the value of both. IncludedDeletedBackTo is provided for backwards compatibility only and assigning a non-Utc DateTime to it results in the wrong timestamp being passed to the service. If specified when `IncludeDeleted` is set to `true`, then environments deleted after this date are displayed.
IncludedDeletedBackToUtc	System.DateTime	Gets and sets the property IncludedDeletedBackToUtc. If specified when `IncludeDeleted` is set to `true`, then environments deleted after this date are displayed.
IncludeDeleted	System.Boolean	Gets and sets the property IncludeDeleted. Indicates whether to include deleted environments: `true`: Environments that have been deleted after `IncludedDeletedBackTo` are displayed. `false`: Do not include deleted environments.
MaxRecords	System.Int32	Gets and sets the property MaxRecords. 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.
NextToken	System.String	Gets and sets the property NextToken. 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.
VersionLabel	System.String	Gets and sets the property VersionLabel. If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version.

Examples

The following operation retrieves information about an environment named my-env:

To view information about an environment


var client = new AmazonElasticBeanstalkClient();
var response = client.DescribeEnvironments(new DescribeEnvironmentsRequest 
{
    EnvironmentNames = new List<string> {
        "my-env"
    }
});

List<EnvironmentDescription> environments = response.Environments;

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5