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:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginDescribeInstanceHealth and EndDescribeInstanceHealth.

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

Syntax

C#
public abstract Task<DescribeInstanceHealthResponse> DescribeInstanceHealthAsync(
         DescribeInstanceHealthRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.ElasticLoadBalancing.Model.DescribeInstanceHealthRequest

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

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

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.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also