Describes the specified target groups or all of your target groups. By default, all target groups are described. Alternatively, you can specify one of the following to filter the results: the ARN of the load balancer, the names of one or more target groups, or the ARNs of one or more target groups.
See also: AWS API Documentation
describe-target-groups
is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate
argument.
When using --output text
and the --query
argument on a paginated response, the --query
argument must extract data from the results of the following query expressions: TargetGroups
describe-target-groups
[--load-balancer-arn <value>]
[--target-group-arns <value>]
[--names <value>]
[--page-size <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--max-items <value>]
[--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]
--load-balancer-arn
(string)
The Amazon Resource Name (ARN) of the load balancer.
--target-group-arns
(list)
The Amazon Resource Names (ARN) of the target groups.
(string)
Syntax:
"string" "string" ...
--names
(list)
The names of the target groups.
(string)
Syntax:
"string" "string" ...
--page-size
(integer)
The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.
For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--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
.
--starting-token
(string)
A token to specify where to start paginating. This is the
NextToken
from a previously truncated response.For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--max-items
(integer)
The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a
NextToken
is provided in the command’s output. To resume pagination, provide theNextToken
value in thestarting-token
argument of a subsequent command. Do not use theNextToken
response element directly outside of the AWS CLI.For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--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.
--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.
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 a target group
The following describe-target-groups
example displays details for the specified target group.
aws elbv2 describe-target-groups \
--target-group-arns arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067
Output:
{
"TargetGroups": [
{
"TargetGroupName": "my-targets",
"Protocol": "HTTP",
"Port": 80,
"VpcId": "vpc-3ac0fb5f",
"TargetType": "instance",
"HealthCheckEnabled": true,
"UnhealthyThresholdCount": 2,
"HealthyThresholdCount": 5,
"HealthCheckPath": "/",
"Matcher": {
"HttpCode": "200"
},
"HealthCheckProtocol": "HTTP",
"HealthCheckPort": "traffic-port",
"HealthCheckIntervalSeconds": 30,
"HealthCheckTimeoutSeconds": 5,
"TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067",
"LoadBalancerArns": [
"arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188"
]
}
]
}
Example 2: To describe all target groups for a load balancer
The following describe-target-groups
example displays details for all target groups for the specified load balancer.
aws elbv2 describe-target-groups \
--load-balancer-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188
Example 3: To describe all target groups
The following describe-target-groups
example dislplays details for all of your target groups.
aws elbv2 describe-target-groups
TargetGroups -> (list)
Information about the target groups.
(structure)
Information about a target group.
TargetGroupArn -> (string)
The Amazon Resource Name (ARN) of the target group.
TargetGroupName -> (string)
The name of the target group.
Protocol -> (string)
The protocol to use for routing traffic to the targets.
Port -> (integer)
The port on which the targets are listening. Not used if the target is a Lambda function.
VpcId -> (string)
The ID of the VPC for the targets.
HealthCheckProtocol -> (string)
The protocol to use to connect with the target. The GENEVE, TLS, UDP, and TCP_UDP protocols are not supported for health checks.
HealthCheckPort -> (string)
The port to use to connect with the target.
HealthCheckEnabled -> (boolean)
Indicates whether health checks are enabled.
HealthCheckIntervalSeconds -> (integer)
The approximate amount of time, in seconds, between health checks of an individual target.
HealthCheckTimeoutSeconds -> (integer)
The amount of time, in seconds, during which no response means a failed health check.
HealthyThresholdCount -> (integer)
The number of consecutive health checks successes required before considering an unhealthy target healthy.
UnhealthyThresholdCount -> (integer)
The number of consecutive health check failures required before considering the target unhealthy.
HealthCheckPath -> (string)
The destination for health checks on the targets.
Matcher -> (structure)
The HTTP or gRPC codes to use when checking for a successful response from a target.
HttpCode -> (string)
For Application Load Balancers, you can specify values between 200 and 499, with the default value being 200. You can specify multiple values (for example, “200,202”) or a range of values (for example, “200-299”).
For Network Load Balancers, you can specify values between 200 and 599, with the default value being 200-399. You can specify multiple values (for example, “200,202”) or a range of values (for example, “200-299”).
For Gateway Load Balancers, this must be “200–399”.
Note that when using shorthand syntax, some values such as commas need to be escaped.
GrpcCode -> (string)
You can specify values between 0 and 99. You can specify multiple values (for example, “0,1”) or a range of values (for example, “0-5”). The default value is 12.
LoadBalancerArns -> (list)
The Amazon Resource Names (ARN) of the load balancers that route traffic to this target group.
(string)
TargetType -> (string)
The type of target that you must specify when registering targets with this target group. The possible values are
instance
(register targets by instance ID),ip
(register targets by IP address),lambda
(register a single Lambda function as a target), oralb
(register a single Application Load Balancer as a target).ProtocolVersion -> (string)
[HTTP/HTTPS protocol] The protocol version. The possible values are
GRPC
,HTTP1
, andHTTP2
.IpAddressType -> (string)
The type of IP address used for this target group. The possible values are
ipv4
andipv6
. This is an optional parameter. If not specified, the IP address type defaults toipv4
.
NextMarker -> (string)
If there are additional results, this is the marker for the next set of results. Otherwise, this is null.