Describe Target Health

elbv2_describe_target_health

R Documentation

Describes the health of the specified targets or all of your targets

Description

Describes the health of the specified targets or all of your targets.

Usage

elbv2_describe_target_health(TargetGroupArn, Targets, Include)

Arguments

TargetGroupArn

[required] The Amazon Resource Name (ARN) of the target group.

Targets

The targets.

Include

Used to include anomaly detection information.

Value

A list with the following syntax:

list(
  TargetHealthDescriptions = list(
    list(
      Target = list(
        Id = "string",
        Port = 123,
        AvailabilityZone = "string"
      ),
      HealthCheckPort = "string",
      TargetHealth = list(
        State = "initial"|"healthy"|"unhealthy"|"unhealthy.draining"|"unused"|"draining"|"unavailable",
        Reason = "Elb.RegistrationInProgress"|"Elb.InitialHealthChecking"|"Target.ResponseCodeMismatch"|"Target.Timeout"|"Target.FailedHealthChecks"|"Target.NotRegistered"|"Target.NotInUse"|"Target.DeregistrationInProgress"|"Target.InvalidState"|"Target.IpUnusable"|"Target.HealthCheckDisabled"|"Elb.InternalError",
        Description = "string"
      ),
      AnomalyDetection = list(
        Result = "anomalous"|"normal",
        MitigationInEffect = "yes"|"no"
      )
    )
  )
)

Request syntax

svc$describe_target_health(
  TargetGroupArn = "string",
  Targets = list(
    list(
      Id = "string",
      Port = 123,
      AvailabilityZone = "string"
    )
  ),
  Include = list(
    "AnomalyDetection"|"All"
  )
)

Examples

## Not run: 
# 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.
svc$describe_target_health(
  TargetGroupArn = "arn:aws:elasticloadbalancing:us-west-2:123456789012:tar..."
)

# This example describes the health of the specified target. This target
# is healthy.
svc$describe_target_health(
  TargetGroupArn = "arn:aws:elasticloadbalancing:us-west-2:123456789012:tar...",
  Targets = list(
    list(
      Id = "i-0f76fade",
      Port = 80L
    )
  )
)

## End(Not run)