Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1473359323.2 KB

Creates a target group. A target group is a collection of targets, or compute resources, that run your application or service. A target group can only be used by a single service.

For more information, see Target groups in the Amazon VPC Lattice User Guide.

post/targetgroups

Request body

namestring required

The name of the target group. The name must be unique within the account. The valid characters are a-z, 0-9, and hyphens (-). You can't use a hyphen as the first or last character, or immediately after another hyphen.

type'IP' | 'LAMBDA' | 'INSTANCE' | 'ALB' required

The type of target group.

clientTokenstring

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry succeeds without performing any actions. If the parameters aren't identical, the retry fails.

tagsobject

The tags for the target group.

Response

Success

idstring

The ID of the target group.

arnstring

The Amazon Resource Name (ARN) of the target group.

namestring

The name of the target group.

type'IP' | 'LAMBDA' | 'INSTANCE' | 'ALB'

The type of target group.

status'CREATE_IN_PROGRESS' | 'ACTIVE' | 'DELETE_IN_PROGRESS' | 'CREATE_FAILED' | 'DELETE_FAILED'

The status. You can retry the operation if the status is <code>CREATE_FAILED</code>. However, if you retry it while the status is <code>CREATE_IN_PROGRESS</code>, there is no change in the status.