describe-target-health¶
Description¶
Describes the health of the specified targets or all of your targets.
See also: AWS API Documentation
Synopsis¶
describe-target-health
--target-group-arn <value>
[--targets <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
Options¶
--target-group-arn (string)
The Amazon Resource Name (ARN) of the target group.
--targets (list)
The targets.
(structure)
Information about a target.
Id -> (string)
The ID of the target. If the target type of the target group is
instance, specify an instance ID. If the target type isip, specify an IP address. If the target type islambda, specify the ARN of the Lambda function. If the target type isalb, specify the ARN of the Application Load Balancer target.Port -> (integer)
The port on which the target is listening. If the target group protocol is GENEVE, the supported port is 6081. If the target type is
alb, the targeted Application Load Balancer must have at least one listener whose port matches the target group port. Not used if the target is a Lambda function.AvailabilityZone -> (string)
An Availability Zone or
all. This determines whether the target receives traffic from the load balancer nodes in the specified Availability Zone or from all enabled Availability Zones for the load balancer.For Application Load Balancer target groups, the specified Availability Zone value is only applicable when cross-zone load balancing is off. Otherwise the parameter is ignored and treated as
all.This parameter is not supported if the target type of the target group is
instanceoralb.If the target type is
ipand the IP address is in a subnet of the VPC for the target group, the Availability Zone is automatically detected and this parameter is optional. If the IP address is outside the VPC, this parameter is required.For Application Load Balancer target groups with cross-zone load balancing off, if the target type is
ipand the IP address is outside of the VPC for the target group, this should be an Availability Zone inside the VPC for the target group.If the target type is
lambda, this parameter is optional and the only supported value isall.
Shorthand Syntax:
Id=string,Port=integer,AvailabilityZone=string ...
JSON Syntax:
[
{
"Id": "string",
"Port": integer,
"AvailabilityZone": "string"
}
...
]
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
Global Options¶
--debug (boolean)
Turn on debug logging.
--endpoint-url (string)
Override command’s default URL with the given URL.
--no-verify-ssl (boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate (boolean)
Disable automatic pagination.
--output (string)
The formatting style for command output.
json
text
table
yaml
yaml-stream
--query (string)
A JMESPath query to use in filtering the response data.
--profile (string)
Use a specific profile from your credential file.
--region (string)
The region to use. Overrides config/env settings.
--version (string)
Display the version of this tool.
--color (string)
Turn on/off color output.
on
off
auto
--no-sign-request (boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle (string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout (int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout (int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
--cli-binary-format (string)
The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.
base64
raw-in-base64-out
--no-cli-pager (boolean)
Disable cli pager for output.
--cli-auto-prompt (boolean)
Automatically prompt for CLI input parameters.
--no-cli-auto-prompt (boolean)
Disable automatically prompt for CLI input parameters.
Examples¶
Note
To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.
Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .
Example 1: To describe the health of the targets for a target group
The following describe-target-health example displays health details for the targets of the specified target group. These targets are healthy.
aws elbv2 describe-target-health \
--target-group-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067
Output:
{
"TargetHealthDescriptions": [
{
"HealthCheckPort": "80",
"Target": {
"Id": "i-ceddcd4d",
"Port": 80
},
"TargetHealth": {
"State": "healthy"
}
},
{
"HealthCheckPort": "80",
"Target": {
"Id": "i-0f76fade",
"Port": 80
},
"TargetHealth": {
"State": "healthy"
}
}
]
}
Example 2: To describe the health of a target
The following describe-target-health example displays health details for the specified target. This target is healthy.
aws elbv2 describe-target-health \
--targets Id=i-0f76fade,Port=80 \
--target-group-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067
Output:
{
"TargetHealthDescriptions": [
{
"HealthCheckPort": "80",
"Target": {
"Id": "i-0f76fade",
"Port": 80
},
"TargetHealth": {
"State": "healthy"
}
}
]
}
The following example output is for a target whose target group is not specified in an action for a listener. This target can’t receive traffic from the load balancer.
{
"TargetHealthDescriptions": [
{
"HealthCheckPort": "80",
"Target": {
"Id": "i-0f76fade",
"Port": 80
},
"TargetHealth": {
"State": "unused",
"Reason": "Target.NotInUse",
"Description": "Target group is not configured to receive traffic from the load balancer"
}
}
]
}
The following example output is for a target whose target group was just specified in an action for a listener. The target is still being registered.
{
"TargetHealthDescriptions": [
{
"HealthCheckPort": "80",
"Target": {
"Id": "i-0f76fade",
"Port": 80
},
"TargetHealth": {
"State": "initial",
"Reason": "Elb.RegistrationInProgress",
"Description": "Target registration is in progress"
}
}
]
}
The following example output is for an unhealthy target.
{
"TargetHealthDescriptions": [
{
"HealthCheckPort": "80",
"Target": {
"Id": "i-0f76fade",
"Port": 80
},
"TargetHealth": {
"State": "unhealthy",
"Reason": "Target.Timeout",
"Description": "Connection to target timed out"
}
}
]
}
The following example output is for a target that is a Lambda function and health checks are disabled.
{
"TargetHealthDescriptions": [
{
"Target": {
"Id": "arn:aws:lambda:us-west-2:123456789012:function:my-function",
"AvailabilityZone": "all",
},
"TargetHealth": {
"State": "unavailable",
"Reason": "Target.HealthCheckDisabled",
"Description": "Health checks are not enabled for this target"
}
}
]
}
Output¶
TargetHealthDescriptions -> (list)
Information about the health of the targets.
(structure)
Information about the health of a target.
Target -> (structure)
The description of the target.
Id -> (string)
The ID of the target. If the target type of the target group is
instance, specify an instance ID. If the target type isip, specify an IP address. If the target type islambda, specify the ARN of the Lambda function. If the target type isalb, specify the ARN of the Application Load Balancer target.Port -> (integer)
The port on which the target is listening. If the target group protocol is GENEVE, the supported port is 6081. If the target type is
alb, the targeted Application Load Balancer must have at least one listener whose port matches the target group port. Not used if the target is a Lambda function.AvailabilityZone -> (string)
An Availability Zone or
all. This determines whether the target receives traffic from the load balancer nodes in the specified Availability Zone or from all enabled Availability Zones for the load balancer.For Application Load Balancer target groups, the specified Availability Zone value is only applicable when cross-zone load balancing is off. Otherwise the parameter is ignored and treated as
all.This parameter is not supported if the target type of the target group is
instanceoralb.If the target type is
ipand the IP address is in a subnet of the VPC for the target group, the Availability Zone is automatically detected and this parameter is optional. If the IP address is outside the VPC, this parameter is required.For Application Load Balancer target groups with cross-zone load balancing off, if the target type is
ipand the IP address is outside of the VPC for the target group, this should be an Availability Zone inside the VPC for the target group.If the target type is
lambda, this parameter is optional and the only supported value isall.HealthCheckPort -> (string)
The port to use to connect with the target.
TargetHealth -> (structure)
The health information for the target.
State -> (string)
The state of the target.
Reason -> (string)
The reason code.
If the target state is
healthy, a reason code is not provided.If the target state is
initial, the reason code can be one of the following values:
Elb.RegistrationInProgress- The target is in the process of being registered with the load balancer.
Elb.InitialHealthChecking- The load balancer is still sending the target the minimum number of health checks required to determine its health status.If the target state is
unhealthy, the reason code can be one of the following values:
Target.ResponseCodeMismatch- The health checks did not return an expected HTTP code. Applies only to Application Load Balancers and Gateway Load Balancers.
Target.Timeout- The health check requests timed out. Applies only to Application Load Balancers and Gateway Load Balancers.
Target.FailedHealthChecks- The load balancer received an error while establishing a connection to the target or the target response was malformed.
Elb.InternalError- The health checks failed due to an internal error. Applies only to Application Load Balancers.If the target state is
unused, the reason code can be one of the following values:
Target.NotRegistered- The target is not registered with the target group.
Target.NotInUse- The target group is not used by any load balancer or the target is in an Availability Zone that is not enabled for its load balancer.
Target.InvalidState- The target is in the stopped or terminated state.
Target.IpUnusable- The target IP address is reserved for use by a load balancer.If the target state is
draining, the reason code can be the following value:
Target.DeregistrationInProgress- The target is in the process of being deregistered and the deregistration delay period has not expired.If the target state is
unavailable, the reason code can be the following value:
Target.HealthCheckDisabled- Health checks are disabled for the target group. Applies only to Application Load Balancers.
Elb.InternalError- Target health is unavailable due to an internal error. Applies only to Network Load Balancers.Description -> (string)
A description of the target health that provides additional details. If the state is
healthy, a description is not provided.