DescribeEnvironmentHealthResponse Class

Health details for an AWS Elastic Beanstalk environment.

Inheritance Hierarchy

System.Object
Amazon.Runtime.AmazonWebServiceResponse
Amazon.ElasticBeanstalk.Model.DescribeEnvironmentHealthResponse

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

Syntax

public class DescribeEnvironmentHealthResponse : AmazonWebServiceResponse

The DescribeEnvironmentHealthResponse type exposes the following members

Constructors

	Name	Description
	DescribeEnvironmentHealthResponse()

Properties

Name	Type	Description
ApplicationMetrics	Amazon.ElasticBeanstalk.Model.ApplicationMetrics	Gets and sets the property ApplicationMetrics. Application request metrics for the environment.
Causes	System.Collections.Generic.List<System.String>	Gets and sets the property Causes. Descriptions of the data that contributed to the environment's current health status.
Color	System.String	Gets and sets the property Color. The health color of the environment.
ContentLength	System.Int64	Inherited from Amazon.Runtime.AmazonWebServiceResponse.
EnvironmentName	System.String	Gets and sets the property EnvironmentName. The environment's name.
HealthStatus	System.String	Gets and sets the property HealthStatus. The health status of the environment. For example, `Ok`.
HttpStatusCode	System.Net.HttpStatusCode	Inherited from Amazon.Runtime.AmazonWebServiceResponse.
InstancesHealth	Amazon.ElasticBeanstalk.Model.InstanceHealthSummary	Gets and sets the property InstancesHealth. Summary health information for the instances in the environment.
RefreshedAt	System.DateTime	Gets and sets the property RefreshedAt. The date and time that the health information was retrieved.
ResponseMetadata	Amazon.Runtime.ResponseMetadata	Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Status	Amazon.ElasticBeanstalk.EnvironmentHealth	Gets and sets the property Status. The environment's operational status. `Ready`, `Launching`, `Updating`, `Terminating`, or `Terminated`.

Examples

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

To view environment health


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;

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5