AmazonAutoScalingClient.DescribeLoadBalancerTargetGroups Method (DescribeLoadBalancerTargetGroupsRequest)

This API operation is superseded by DescribeTrafficSources, which can describe multiple traffic sources types. We recommend using DetachTrafficSources to simplify how you manage traffic sources. However, we continue to support DescribeLoadBalancerTargetGroups. You can use both the original DescribeLoadBalancerTargetGroups API operation and DescribeTrafficSources on the same Auto Scaling group.

Gets information about the Elastic Load Balancing target groups for the specified Auto Scaling group.

To determine the attachment status of the target group, use the State element in the response. When you attach a target group to an Auto Scaling group, the initial State value is Adding. The state transitions to Added after all Auto Scaling instances are registered with the target group. If Elastic Load Balancing health checks are enabled for the Auto Scaling group, the state transitions to InService after at least one Auto Scaling instance passes the health check. When the target group is in the InService state, Amazon EC2 Auto Scaling can terminate and replace any instances that are reported as unhealthy. If no registered instances pass the health checks, the target group doesn't enter the InService state.

Target groups also have an InService state if you attach them in the CreateAutoScalingGroup API call. If your target group state is InService, but it is not working properly, check the scaling activities by calling DescribeScalingActivities and take any corrective actions necessary.

For help with failed health checks, see Troubleshooting Amazon EC2 Auto Scaling: Health checks in the Amazon EC2 Auto Scaling User Guide. For more information, see Use Elastic Load Balancing to distribute traffic across the instances in your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.

You can use this operation to describe target groups that were attached by using AttachLoadBalancerTargetGroups, but not for target groups that were attached by using AttachTrafficSources.

Note:

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

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

Syntax

public virtual DescribeLoadBalancerTargetGroupsResponse DescribeLoadBalancerTargetGroups(
         DescribeLoadBalancerTargetGroupsRequest request
)

Parameters

request: Type: Amazon.AutoScaling.Model.DescribeLoadBalancerTargetGroupsRequest

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

Return Value

Type: DescribeLoadBalancerTargetGroupsResponse

The response from the DescribeLoadBalancerTargetGroups service method, as returned by AutoScaling.

Exceptions

Exception	Condition
InvalidNextTokenException	The NextToken value is not valid.
ResourceContentionException	You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).

Examples

This example describes the target groups attached to the specified Auto Scaling group.

To describe the target groups for an Auto Scaling group


var client = new AmazonAutoScalingClient();
var response = client.DescribeLoadBalancerTargetGroups(new DescribeLoadBalancerTargetGroupsRequest 
{
    AutoScalingGroupName = "my-auto-scaling-group"
});

List<LoadBalancerTargetGroupState> loadBalancerTargetGroups = response.LoadBalancerTargetGroups;

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

AmazonAutoScalingClient.DescribeLoadBalancerTargetGroups (DescribeLoadBalancerTargetGroupsRequest)

Method