We are excited to announce our new API Documentation.
Protected
Gets a VPC link.
Use a bare-bones client and the command you need to make an API call.
import { ApiGatewayV2Client, GetVpcLinkCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import// const { ApiGatewayV2Client, GetVpcLinkCommand } = require("@aws-sdk/client-apigatewayv2"); // CommonJS importconst client = new ApiGatewayV2Client(config);const input = { // GetVpcLinkRequest VpcLinkId: "STRING_VALUE", // required};const command = new GetVpcLinkCommand(input);const response = await client.send(command);// { // GetVpcLinkResponse// CreatedDate: new Date("TIMESTAMP"),// Name: "STRING_VALUE",// SecurityGroupIds: [ // SecurityGroupIdList// "STRING_VALUE",// ],// SubnetIds: [ // SubnetIdList// "STRING_VALUE",// ],// Tags: { // Tags// "<keys>": "STRING_VALUE",// },// VpcLinkId: "STRING_VALUE",// VpcLinkStatus: "PENDING" || "AVAILABLE" || "DELETING" || "FAILED" || "INACTIVE",// VpcLinkStatusMessage: "STRING_VALUE",// VpcLinkVersion: "V2",// };
GetVpcLinkCommandInput
GetVpcLinkCommandOutput
input
response
config
NotFoundException (client fault)
The resource specified in the request was not found. See the message field for more information.
TooManyRequestsException (client fault)
A limit has been exceeded. See the accompanying error message for details.
ApiGatewayV2ServiceException
Base exception class for all service exceptions from ApiGatewayV2 service.
Readonly
Static
Gets a VPC link.
Example
Use a bare-bones client and the command you need to make an API call.
Param
GetVpcLinkCommandInput
Returns
GetVpcLinkCommandOutput
See
input
shape.response
shape.config
shape.Throws
NotFoundException (client fault)
The resource specified in the request was not found. See the message field for more information.
Throws
TooManyRequestsException (client fault)
A limit has been exceeded. See the accompanying error message for details.
Throws
ApiGatewayV2ServiceException
Base exception class for all service exceptions from ApiGatewayV2 service.