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.

Returns information about the overall health of the specified environment. The DescribeEnvironmentHealth operation is only available with AWS Elastic Beanstalk Enhanced Health.

Note:

For PCL this operation is only available in asynchronous form. Please refer to DescribeEnvironmentHealthAsync.

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

Syntax

C#
public virtual DescribeEnvironmentHealthResponse DescribeEnvironmentHealth(
         DescribeEnvironmentHealthRequest request
)
Parameters
request
Type: Amazon.ElasticBeanstalk.Model.DescribeEnvironmentHealthRequest

Container for the necessary parameters to execute the DescribeEnvironmentHealth service method.

Return Value
The response from the DescribeEnvironmentHealth service method, as returned by ElasticBeanstalk.

Exceptions

ExceptionCondition
ElasticBeanstalkServiceException A generic service exception has occurred.
InvalidRequestException One or more input parameters is not valid. Please correct the input parameters and try the operation again.

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

See Also