DeregisterTargets - Amazon VPC Lattice


Deregisters the specified targets from the specified target group.

Request Syntax

POST /targetgroups/targetGroupIdentifier/deregistertargets HTTP/1.1 Content-type: application/json { "targets": [ { "id": "string", "port": number } ] }

URI Request Parameters

The request uses the following URI parameters.


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 accepts the following data in JSON format.


The targets to deregister.

Type: Array of Target objects

Array Members: Minimum number of 1 item. Maximum number of 100 items.

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "successful": [ { "id": "string", "port": number } ], "unsuccessful": [ { "failureCode": "string", "failureMessage": "string", "id": "string", "port": number } ] }

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.


The targets that were successfully deregistered.

Type: Array of Target objects


The targets that the operation couldn't deregister.

Type: Array of TargetFailure objects


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


The user does not have sufficient access to perform this action.

HTTP Status Code: 403


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

HTTP Status Code: 409


An unexpected error occurred while processing the request.

HTTP Status Code: 500


The request references a resource that does not exist.

HTTP Status Code: 404


The limit on the number of requests per second was exceeded.

HTTP Status Code: 429


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: