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.

Detailed health information about the Amazon EC2 instances in an AWS Elastic Beanstalk environment.

Inheritance Hierarchy

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

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

Syntax

C#
public class DescribeInstancesHealthResponse : AmazonWebServiceResponse

The DescribeInstancesHealthResponse type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property ContentLength System.Int64 Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property HttpStatusCode System.Net.HttpStatusCode Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property InstanceHealthList System.Collections.Generic.List<Amazon.ElasticBeanstalk.Model.SingleInstanceHealth>

Gets and sets the property InstanceHealthList.

Detailed health information about each instance.

The output differs slightly between Linux and Windows environments. There is a difference in the members that are supported under the type.

Public Property NextToken System.String

Gets and sets the property NextToken.

Pagination token for the next page of results, if available.

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.

Examples

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

To view environment health


var client = new AmazonElasticBeanstalkClient();
var response = client.DescribeInstancesHealth(new DescribeInstancesHealthRequest 
{
    AttributeNames = new List<string> {
        "All"
    },
    EnvironmentName = "my-env"
});

List<SingleInstanceHealth> instanceHealthList = response.InstanceHealthList;
DateTime refreshedAt = response.RefreshedAt;

            

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5