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 DescribeEnvironmentHealth operation. Returns information about the overall health of the specified environment. The DescribeEnvironmentHealth operation is only available with AWS Elastic Beanstalk Enhanced Health.

Inheritance Hierarchy

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

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

Syntax

C#
public class DescribeEnvironmentHealthRequest : AmazonElasticBeanstalkRequest
         IAmazonWebServiceRequest

The DescribeEnvironmentHealthRequest type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property AttributeNames System.Collections.Generic.List<System.String>

Gets and sets the property AttributeNames.

Specify the response elements to return. To retrieve all attributes, set to All. If no attribute names are specified, returns the name of the environment.

Public Property EnvironmentId System.String

Gets and sets the property EnvironmentId.

Specify the environment by ID.

You must specify either this or an EnvironmentName, or both.

Public Property EnvironmentName System.String

Gets and sets the property EnvironmentName.

Specify the environment by name.

You must specify either this or an EnvironmentName, or both.

Examples

The following operation retrieves overall health information for an environment named my-env:

To view environment health


var response = client.DescribeEnvironmentHealth(new DescribeEnvironmentHealthRequest 
{
    AttributeNames = new List {
        "All"
    },
    EnvironmentName = "my-env"
});

ApplicationMetrics applicationMetrics = response.ApplicationMetrics;
List causes = response.Causes;
string color = response.Color;
string environmentName = response.EnvironmentName;
string healthStatus = response.HealthStatus;
InstanceHealthSummary instancesHealth = response.InstancesHealth;
DateTime refreshedAt = response.RefreshedAt;

            

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