Amazon Elastic Load Balancing · JSON Structure

Amazon Elastic Load Balancing Describe Target Health Response Structure

Response from the DescribeTargetHealth action

Type: object Properties: 1
Amazon Web ServicesHigh AvailabilityLoad BalancingNetworkingScalability

DescribeTargetHealthResponse is a JSON Structure definition published by Amazon Elastic Load Balancing, describing 1 property. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

targetHealthDescriptions

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-elastic-load-balancing/refs/heads/main/json-structure/amazon-elastic-load-balancing-describe-target-health-response-structure.json",
  "name": "DescribeTargetHealthResponse",
  "description": "Response from the DescribeTargetHealth action",
  "type": "object",
  "properties": {
    "targetHealthDescriptions": {
      "type": "array",
      "description": "Information about the health of the targets",
      "items": {
        "type": "object",
        "properties": {
          "target": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "description": "The ID of the target"
              },
              "port": {
                "type": "int32",
                "description": "The port on which the target is listening"
              }
            }
          },
          "targetHealth": {
            "type": "object",
            "properties": {
              "state": {
                "type": "string",
                "description": "The state of the target",
                "enum": [
                  "initial",
                  "healthy",
                  "unhealthy",
                  "unused",
                  "draining",
                  "unavailable"
                ]
              },
              "reason": {
                "type": "string",
                "description": "The reason code"
              },
              "description": {
                "type": "string",
                "description": "A description of the target health"
              }
            }
          }
        }
      }
    }
  }
}