Skip to content

Describes the state of the specified instances with respect to the specified load balancer

Description

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.

Usage

elb_describe_instance_health(LoadBalancerName, Instances)

Arguments

  • LoadBalancerName

    [required] The name of the load balancer.

  • Instances

    The IDs of the instances.

Value

A list with the following syntax:

list(
  InstanceStates = list(
    list(
      InstanceId = "string",
      State = "string",
      ReasonCode = "string",
      Description = "string"
    )
  )
)

Request syntax

svc$describe_instance_health(
  LoadBalancerName = "string",
  Instances = list(
    list(
      InstanceId = "string"
    )
  )
)

Examples

# This example describes the health of the instances for the specified
# load balancer.
svc$describe_instance_health(
  LoadBalancerName = "my-load-balancer"
)