Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

DeleteTargetGroup

Deletes a target group. You can't delete a target group if it is used in a listener rule or if the target group creation is in progress.

Request Syntax


DELETE /targetgroups/targetGroupIdentifier HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

targetGroupIdentifier

The ID or Amazon Resource Name (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",
   "id": "string",
   "status": "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}$

id

The ID of the target group.

Type: String

Length Constraints: Fixed length of 20.

Pattern: ^tg-[0-9a-z]{17}$

status

The status. You can retry the operation if the status is DELETE_FAILED. However, if you retry it while the status is DELETE_IN_PROGRESS, the status doesn't change.

Type: String

Valid Values: CREATE_IN_PROGRESS | ACTIVE | DELETE_IN_PROGRESS | CREATE_FAILED | DELETE_FAILED

Errors

For information about the errors that are common to all actions, see Common Errors.

ConflictException

The request conflicts with the current state of the resource. Updating or deleting a resource can cause an inconsistent state.

HTTP Status Code: 409

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