Jump to Content

This API Documentation is now deprecated

We are excited to announce our new API Documentation.

Class GetVpcLinkCommandProtected

Gets a VPC link.

Example

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 import
const 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",
// };

Param

GetVpcLinkCommandInput

Returns

GetVpcLinkCommandOutput

See

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.

Hierarchy

Constructors

Properties

Methods

Constructors

Properties

Methods