AmazonElasticBeanstalkClient.DescribeInstancesHealth Method (DescribeInstancesHealthRequest)

Retrieves detailed information about the health of instances in your AWS Elastic Beanstalk. This operation requires enhanced health reporting.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to DescribeInstancesHealthAsync.

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

Syntax

public virtual DescribeInstancesHealthResponse DescribeInstancesHealth(
         DescribeInstancesHealthRequest request
)

Parameters

request: Type: Amazon.ElasticBeanstalk.Model.DescribeInstancesHealthRequest

Container for the necessary parameters to execute the DescribeInstancesHealth service method.

Return Value

Type: DescribeInstancesHealthResponse

The response from the DescribeInstancesHealth service method, as returned by ElasticBeanstalk.

Exceptions

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.

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 Framework:
Supported in: 4.5 and newer, 3.5

AmazonElasticBeanstalkClient.DescribeInstancesHealth (DescribeInstancesHealthRequest)

Method