GetTargetGroup
Retrieves information about the specified target group.
Request Syntax
GET /targetgroups/targetGroupIdentifier HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- 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 does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"arn": "string",
"config": {
"healthCheck": {
"enabled": boolean,
"healthCheckIntervalSeconds": number,
"healthCheckTimeoutSeconds": number,
"healthyThresholdCount": number,
"matcher": { ... },
"path": "string",
"port": number,
"protocol": "string",
"protocolVersion": "string",
"unhealthyThresholdCount": number
},
"ipAddressType": "string",
"lambdaEventStructureVersion": "string",
"port": number,
"protocol": "string",
"protocolVersion": "string",
"vpcIdentifier": "string"
},
"createdAt": "string",
"failureCode": "string",
"failureMessage": "string",
"id": "string",
"lastUpdatedAt": "string",
"name": "string",
"serviceArns": [ "string" ],
"status": "string",
"type": "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.
- arn
-
The Amazon Resource Name (ARN) of the target group.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
^arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:targetgroup/tg-[0-9a-z]{17}$ - config
-
The target group configuration.
Type: TargetGroupConfig object
- createdAt
-
The date and time that the target group was created, in ISO-8601 format.
Type: Timestamp
- failureCode
-
The failure code.
Type: String
- failureMessage
-
The failure message.
Type: String
- id
-
The ID of the target group.
Type: String
Length Constraints: Fixed length of 20.
Pattern:
^tg-[0-9a-z]{17}$ - lastUpdatedAt
-
The date and time that the target group was last updated, in ISO-8601 format.
Type: Timestamp
- name
-
The name of the target group.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 128.
Pattern:
^(?!tg-)(?![-])(?!.*[-]$)(?!.*[-]{2})[a-z0-9-]+$ - serviceArns
-
The Amazon Resource Names (ARNs) of the service.
Type: Array of strings
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
^arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:service/svc-[0-9a-z]{17}$ - status
-
The status.
Type: String
Valid Values:
CREATE_IN_PROGRESS | ACTIVE | DELETE_IN_PROGRESS | CREATE_FAILED | DELETE_FAILED - type
-
The target group type.
Type: String
Valid Values:
IP | LAMBDA | INSTANCE | ALB
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:
