VPCLink - Amazon API Gateway

VPCLink

Represents a VPC link. A VPC link enables you to create integrations with private resources in a VPC.

/v2/vpclinks/vpcLinkId

Operation ID: GetVpcLink

Gets a VPC link.

Path Parameters
Name Type Required Description
vpcLinkId String True

The ID of the VPC link.

Responses
Status Code Response Model Description
200 VpcLink

Success

404 NotFoundException

The resource specified in the request was not found.

429 LimitExceededException

The client is sending more than the allowed number of requests per unit of time.

Operation ID: DeleteVpcLink

Deletes a VPC link.

Path Parameters
Name Type Required Description
vpcLinkId String True

The ID of the VPC link.

Responses
Status Code Response Model Description
202 None

202 response

404 NotFoundException

The resource specified in the request was not found.

429 LimitExceededException

The client is sending more than the allowed number of requests per unit of time.

Operation ID: UpdateVpcLink

Updates a VPC link.

Path Parameters
Name Type Required Description
vpcLinkId String True

The ID of the VPC link.

Responses
Status Code Response Model Description
200 VpcLink

200 response

400 BadRequestException

One of the parameters in the request is invalid.

404 NotFoundException

The resource specified in the request was not found.

429 LimitExceededException

The client is sending more than the allowed number of requests per unit of time.

{ "name": "string" }
{ "vpcLinkId": "string", "name": "string", "subnetIds": [ "string" ], "securityGroupIds": [ "string" ], "tags": { }, "createdDate": "string", "vpcLinkStatus": enum, "vpcLinkStatusMessage": "string", "vpcLinkVersion": enum }
{ "message": "string" }
{ "message": "string", "resourceType": "string" }
{ "message": "string", "limitType": "string" }

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

Property Type Required Description
message

string

False

Describes the error encountered.

A limit has been exceeded. See the accompanying error message for details.

Property Type Required Description
message

string

False

Describes the error encountered.

limitType

string

False

The limit type.

The resource specified in the request was not found. See the message field for more information.

Property Type Required Description
message

string

False

Describes the error encountered.

resourceType

string

False

The resource type.

Represents a collection of tags associated with the resource.

Property Type Required Description

*

string

False

Represents the input parameters for an UpdateVpcLink request.

Property Type Required Description
name

string

False

The name of the VPC link.

Represents a VPC link.

Property Type Required Description
vpcLinkId

string

True

The ID of the VPC link.

name

string

True

The name of the VPC link.

subnetIds

Array of type string

True

A list of subnet IDs to include in the VPC link.

securityGroupIds

Array of type string

True

A list of security group IDs for the VPC link.

tags

Tags

False

Tags for the VPC link.

createdDate

string

Format: date-time

False

The timestamp when the VPC link was created.

vpcLinkStatus

VpcLinkStatus

False

The status of the VPC link.

vpcLinkStatusMessage

string

False

A message summarizing the cause of the status of the VPC link.

vpcLinkVersion

VpcLinkVersion

False

The version of the VPC link.

The status of the VPC link.

  • PENDING

  • AVAILABLE

  • DELETING

  • FAILED

  • INACTIVE

The version of the VPC link.

  • V2

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