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.

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

C#
public class DescribeEnvironmentHealthResponse : AmazonWebServiceResponse

The DescribeEnvironmentHealthResponse type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property ApplicationMetrics Amazon.ElasticBeanstalk.Model.ApplicationMetrics

Gets and sets the property ApplicationMetrics.

Application request metrics for the environment.

Public Property 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.

Public Property Color System.String

Gets and sets the property Color.

The health color of the environment.

Public Property ContentLength System.Int64 Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property EnvironmentName System.String

Gets and sets the property EnvironmentName.

The environment's name.

Public Property HealthStatus System.String

Gets and sets the property HealthStatus.

The health status of the environment. For example, Ok.

Public Property HttpStatusCode System.Net.HttpStatusCode Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property InstancesHealth Amazon.ElasticBeanstalk.Model.InstanceHealthSummary

Gets and sets the property InstancesHealth.

Summary health information for the instances in the environment.

Public Property RefreshedAt System.DateTime

Gets and sets the property RefreshedAt.

The date and time that the health information was retrieved.

Public Property ResponseMetadata Amazon.Runtime.ResponseMetadata Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property 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 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