Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14120262383.5 KB

Gets a specified VPC link under the caller's account in a region.

get/vpclinks/{vpclink_id}

Path parameters

vpclink_idstring required

The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.

Response

Success

idstring

The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.

namestring

The name used to label and identify the VPC link.

descriptionstring

The description of the VPC link.

targetArnsString[]

The ARN of the network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same AWS account of the API owner.

status'AVAILABLE' | 'PENDING' | 'DELETING' | 'FAILED'

The status of the VPC link. The valid values are <code>AVAILABLE</code>, <code>PENDING</code>, <code>DELETING</code>, or <code>FAILED</code>. Deploying an API will wait if the status is <code>PENDING</code> and will fail if the status is <code>DELETING</code>.

statusMessagestring

A description about the VPC link status.

tagsobject

The collection of tags. Each tag element is associated with a given resource.