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.

Describes the state of the specified instances with respect to the specified load balancer. If no instances are specified, the call describes the state of all instances that are currently registered with the load balancer. If instances are specified, their state is returned even if they are no longer registered with the load balancer. The state of terminated instances is not returned.

Note:

For PCL this operation is only available in asynchronous form. Please refer to DescribeInstanceHealthAsync.

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

Syntax

C#
public virtual DescribeInstanceHealthResponse DescribeInstanceHealth(
         DescribeInstanceHealthRequest request
)
Parameters
request
Type: Amazon.ElasticLoadBalancing.Model.DescribeInstanceHealthRequest

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

Return Value
The response from the DescribeInstanceHealth service method, as returned by ElasticLoadBalancing.

Exceptions

ExceptionCondition
AccessPointNotFoundException The specified load balancer does not exist.
InvalidEndPointException The specified endpoint is not valid.

Examples

This example describes the health of the instances for the specified load balancer.

To describe the health of the instances for a load balancer


var response = client.DescribeInstanceHealth(new DescribeInstanceHealthRequest 
{
    LoadBalancerName = "my-load-balancer"
});

List instanceStates = response.InstanceStates;

            

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