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 health of the specified targets or all of your targets.

Note:

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

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

Syntax

C#
public abstract DescribeTargetHealthResponse DescribeTargetHealth(
         DescribeTargetHealthRequest request
)
Parameters
request
Type: Amazon.ElasticLoadBalancingV2.Model.DescribeTargetHealthRequest

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

Return Value
The response from the DescribeTargetHealth service method, as returned by ElasticLoadBalancingV2.

Exceptions

ExceptionCondition
HealthUnavailableException The health of the specified targets could not be retrieved due to an internal error.
InvalidTargetException The specified target does not exist or is not in the same VPC as the target group.
TargetGroupNotFoundException The specified target group does not exist.

Examples

This example describes the health of the targets for the specified target group. One target is healthy but the other is not specified in an action, so it can't receive traffic from the load balancer.

To describe the health of the targets for a target group


var response = client.DescribeTargetHealth(new DescribeTargetHealthRequest 
{
    TargetGroupArn = "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067"
});

List targetHealthDescriptions = response.TargetHealthDescriptions;

            

This example describes the health of the specified target. This target is healthy.

To describe the health of a target


var response = client.DescribeTargetHealth(new DescribeTargetHealthRequest 
{
    TargetGroupArn = "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067",
    Targets = new List {
        new TargetDescription {
            Id = "i-0f76fade",
            Port = 80
        }
    }
});

List targetHealthDescriptions = response.TargetHealthDescriptions;

            

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