GetVpcLink - Amazon API Gateway


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

GET /vpclinks/vpclink_id HTTP/1.1

The request uses the following URI parameters.

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

Required: Yes

The request does not have a request body.

HTTP/1.1 200 Content-type: application/json { "description": "string", "id": "string", "name": "string", "status": "string", "statusMessage": "string", "tags": { "string" : "string" }, "targetArns": [ "string" ] }

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 description of the VPC link.

Type: String

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

Type: String

The name used to label and identify the VPC link.

Type: String

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

Type: String


A description about the VPC link status.

Type: String

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

Type: String to string map

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.

Type: Array of strings

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


The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

HTTP Status Code: 400


The requested resource is not found. Make sure that the request URI is correct.

HTTP Status Code: 404


The request has reached its throttling limit. Retry after the specified time period.

HTTP Status Code: 429


The request is denied because the caller has insufficient permissions.

HTTP Status Code: 401

For more information about using this API in one of the language-specific AWS SDKs, see the following: