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

RegisterTargets

Registers the targets with the target group. If it's a Lambda target, you can only have one target in a target group.

Request Syntax


POST /targetgroups/targetGroupIdentifier/registertargets HTTP/1.1
Content-type: application/json

{
   "targets": [ 
      { 
         "id": "string",
         "port": number
      }
   ]
}

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

targets

The targets.

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.

successful

The targets that were successfully registered.

Type: Array of Target objects

unsuccessful

The targets that were not registered.

Type: Array of TargetFailure objects

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

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

ServiceQuotaExceededException

The request would cause a service quota to be exceeded.

HTTP Status Code: 402

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