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

UpdateTargetGroup

Updates the specified target group.

Request Syntax


PATCH /targetgroups/targetGroupIdentifier HTTP/1.1
Content-type: application/json

{
   "healthCheck": { 
      "enabled": boolean,
      "healthCheckIntervalSeconds": number,
      "healthCheckTimeoutSeconds": number,
      "healthyThresholdCount": number,
      "matcher": { ... },
      "path": "string",
      "port": number,
      "protocol": "string",
      "protocolVersion": "string",
      "unhealthyThresholdCount": number
   }
}

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

healthCheck

The health check configuration.

Type: HealthCheckConfig object

Required: Yes

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"
   },
   "id": "string",
   "name": "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

id

The ID of the target group.

Type: String

Length Constraints: Fixed length of 20.

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

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-]+

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

ConflictException

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

resourceId: The resource ID.
resourceType: The resource type.

HTTP Status Code: 409

InternalServerException

An unexpected error occurred while processing the request.

retryAfterSeconds: The number of seconds to wait before retrying.

HTTP Status Code: 500

ResourceNotFoundException

The request references a resource that does not exist.

resourceId: The resource ID.
resourceType: The resource type.

HTTP Status Code: 404

ServiceQuotaExceededException

The request would cause a service quota to be exceeded.

quotaCode: The ID of the service quota that was exceeded.
resourceId: The resource ID.
resourceType: The resource type.
serviceCode: The service code.

HTTP Status Code: 402

ThrottlingException

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

quotaCode: The ID of the service quota that was exceeded.
retryAfterSeconds: The number of seconds to wait before retrying.
serviceCode: The service code.

HTTP Status Code: 429

ValidationException

The input does not satisfy the constraints specified by an AWS service.

fieldList: The fields that failed validation.
reason: The reason.

HTTP Status Code: 400