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.
Namespace: Amazon.ElasticBeanstalk.Model
Assembly: AWSSDK.ElasticBeanstalk.dll
Version: 3.x.y.z
public class DescribeEnvironmentHealthRequest : AmazonElasticBeanstalkRequest IAmazonWebServiceRequest
The DescribeEnvironmentHealthRequest type exposes the following members
Name | Description | |
---|---|---|
DescribeEnvironmentHealthRequest() |
Name | Type | Description | |
---|---|---|---|
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 |
|
EnvironmentId | System.String |
Gets and sets the property EnvironmentId. Specify the environment by ID. You must specify either this or an EnvironmentName, or both. |
|
EnvironmentName | System.String |
Gets and sets the property EnvironmentName. Specify the environment by name. You must specify either this or an EnvironmentName, or both. |
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 Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5