URI HTTP methods Schemas Properties See also

VPCLinks

Represents your VPC links as a collection. A collection offers a paginated view of your VPC links.

URI

/v2/vpclinks

HTTP methods

GET

Operation ID: GetVpcLinks

Gets a collection of VPC links.

Query parameters
Name	Type	Required	Description
`nextToken`	String	False	The next page of elements from this collection. Not valid for the last element of the collection.
`maxResults`	String	False	The maximum number of elements to be returned for this resource.

Responses
Status code	Response model	Description
`200`	`VpcLinks`	Success
`400`	`BadRequestException`	One of the parameters in the request is invalid.
`429`	`LimitExceededException`	The client is sending more than the allowed number of requests per unit of time.

POST

Operation ID: CreateVpcLink

Creates a VPC link.

Responses
Status code	Response model	Description
`201`	`VpcLink`	The request has succeeded and has resulted in the creation of a resource.
`400`	`BadRequestException`	One of the parameters in the request is invalid.
`429`	`LimitExceededException`	The client is sending more than the allowed number of requests per unit of time.

Schemas

Request bodies


{
  "name": "string",
  "subnetIds": [
    "string"
  ],
  "securityGroupIds": [
    "string"
  ],
  "tags": {
  }
}

Response bodies


{
  "items": [
    {
      "vpcLinkId": "string",
      "name": "string",
      "subnetIds": [
        "string"
      ],
      "securityGroupIds": [
        "string"
      ],
      "tags": {
      },
      "createdDate": "string",
      "vpcLinkStatus": enum,
      "vpcLinkStatusMessage": "string",
      "vpcLinkVersion": enum
    }
  ],
  "nextToken": "string"
}


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


{
  "message": "string"
}


{
  "message": "string",
  "limitType": "string"
}

Properties

BadRequestException

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.

CreateVpcLinkInput

Represents the input parameters for a CreateVpcLink request.

Property	Type	Required	Description
`name`	string	True	The name of the VPC link.
`securityGroupIds`	Array of type string	False	A list of security group IDs for the VPC link.
`subnetIds`	Array of type string	True	A list of subnet IDs to include in the VPC link.
`tags`	Tags	False	A list of tags.

LimitExceededException

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

Property	Type	Required	Description
`limitType`	string	False	The limit type.
`message`	string	False	Describes the error encountered.

Property	Type	Required	Description
`*`	string	False

VpcLink

Represents a VPC link.

Property	Type	Required	Description
`createdDate`	string Format: date-time	False	The timestamp when the VPC link was created.
`name`	string	True	The name of the VPC link.
`securityGroupIds`	Array of type string	True	A list of security group IDs for the VPC link.
`subnetIds`	Array of type string	True	A list of subnet IDs to include in the VPC link.
`tags`	Tags	False	Tags for the VPC link.
`vpcLinkId`	string	True	The ID of the VPC link.
`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.

VpcLinkStatus

The status of the VPC link.

PENDING
AVAILABLE
DELETING
FAILED
INACTIVE

VpcLinkVersion

The version of the VPC link.

V2

VpcLinks

Represents a collection of VPCLinks.

Property	Type	Required	Description
`items`	Array of type VpcLink	False	A collection of VPC links.
`nextToken`	string	False	The next page of elements from this collection. Not valid for the last element of the collection.