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.
For .NET Core this operation is only available in asynchronous form. Please refer to DescribeEnvironmentHealthAsync.
Namespace: Amazon.ElasticBeanstalk
Assembly: AWSSDK.ElasticBeanstalk.dll
Version: 3.x.y.z
public abstract DescribeEnvironmentHealthResponse DescribeEnvironmentHealth( DescribeEnvironmentHealthRequest request )
Container for the necessary parameters to execute the DescribeEnvironmentHealth service method.
Exception | Condition |
---|---|
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. |
The following operation retrieves overall health information for an environment named my-env:
var client = new AmazonElasticBeanstalkClient(); var response = client.DescribeEnvironmentHealth(new DescribeEnvironmentHealthRequest { AttributeNames = new List<string> { "All" }, EnvironmentName = "my-env" }); ApplicationMetrics applicationMetrics = response.ApplicationMetrics; List<string> causes = response.Causes; string color = response.Color; string environmentName = response.EnvironmentName; string healthStatus = response.HealthStatus; InstanceHealthSummary instancesHealth = response.InstancesHealth; DateTime refreshedAt = response.RefreshedAt;
.NET Framework:
Supported in: 4.5, 4.0, 3.5