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.

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

Note:

For PCL 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

C#
public abstract DescribeInstancesHealthResponse DescribeInstancesHealth(
         DescribeInstancesHealthRequest request
)
Parameters
request
Type: Amazon.ElasticBeanstalk.Model.DescribeInstancesHealthRequest

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

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

Exceptions

ExceptionCondition
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 response = client.DescribeInstancesHealth(new DescribeInstancesHealthRequest 
{
    AttributeNames = new List {
        "All"
    },
    EnvironmentName = "my-env"
});

List instanceHealthList = response.InstanceHealthList;
DateTime refreshedAt = response.RefreshedAt;

            

Version Information

.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

See Also