ListTargets
Lists the targets for the target group. By default, all targets are included. You can use this API to check the health status of targets. You can also filter the results by target.
Request Syntax
POST /targetgroups/targetGroupIdentifier
/listtargets?maxResults=maxResults
&nextToken=nextToken
HTTP/1.1
Content-type: application/json
{
"targets": [
{
"id": "string
",
"port": number
}
]
}
URI Request Parameters
The request uses the following URI parameters.
- maxResults
-
The maximum number of results to return.
Valid Range: Minimum value of 1. Maximum value of 100.
- nextToken
-
A pagination token for the next page of results.
Length Constraints: Minimum length of 1. Maximum length of 2048.
- targetGroupIdentifier
-
The ID or ARN of the target group.
Length Constraints: Minimum length of 17. Maximum length of 2048.
Pattern:
^((tg-[0-9a-z]{17})|(arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:targetgroup/tg-[0-9a-z]{17}))$
Required: Yes
Request Body
The request accepts the following data in JSON format.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"items": [
{
"id": "string",
"port": number,
"reasonCode": "string",
"status": "string"
}
],
"nextToken": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- items
-
Information about the targets.
Type: Array of TargetSummary objects
- nextToken
-
If there are additional results, a pagination token for the next page of results.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
The user does not have sufficient access to perform this action.
HTTP Status Code: 403
- InternalServerException
-
An unexpected error occurred while processing the request.
HTTP Status Code: 500
- ResourceNotFoundException
-
The request references a resource that does not exist.
HTTP Status Code: 404
- ThrottlingException
-
The limit on the number of requests per second was exceeded.
HTTP Status Code: 429
- ValidationException
-
The input does not satisfy the constraints specified by an AWS service.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: