AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

C#
public class DescribeEnvironmentsRequest : AmazonElasticBeanstalkRequest
         IAmazonWebServiceRequest

The DescribeEnvironmentsRequest type exposes the following members

Constructors

NameDescription
Public Method DescribeEnvironmentsRequest()

Empty constructor used to set properties independently even when a simple constructor is available

Properties

NameTypeDescription
Public Property 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.

Public Property 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.

Public Property 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.

Public Property IncludedDeletedBackTo System.DateTime

Gets and sets the property IncludedDeletedBackTo.

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

Public Property 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.

Public Property 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.

Public Property 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.

Public Property 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 response = client.DescribeEnvironments(new DescribeEnvironmentsRequest 
{
    EnvironmentNames = new List {
        "my-env"
    }
});

List environments = response.Environments;

            

Version Information

.NET Standard:
Supported in: 1.3

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

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms