VPCLink
Represents a VPC link. A VPC link enables you to create integrations with private resources in a VPC.
URI
/v2/vpclinks/vpcLinkId
HTTP methods
GET
Operation ID: GetVpcLink
Gets a VPC link.
| Name | Type | Required | Description |
|---|---|---|---|
vpcLinkId | String | True | The ID of the VPC link. |
| 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. |
DELETE
Operation ID: DeleteVpcLink
Deletes a VPC link.
| Name | Type | Required | Description |
|---|---|---|---|
vpcLinkId | String | True | The ID of the VPC link. |
| 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. |
PATCH
Operation ID: UpdateVpcLink
Updates a VPC link.
| Name | Type | Required | Description |
|---|---|---|---|
vpcLinkId | String | True | The ID of the VPC link. |
| 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. |
Schemas
Request bodies
{ "name": "string" }
Response bodies
{ "vpcLinkId": "string", "name": "string", "subnetIds": [ "string" ], "securityGroupIds": [ "string" ], "tags": { }, "createdDate": "string", "vpcLinkStatus": enum, "vpcLinkStatusMessage": "string", "vpcLinkVersion": enum }
{ "message": "string" }
{ "message": "string", "resourceType": "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. |
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. |
NotFoundException
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. |
Tags
Represents a collection of tags associated with the resource.
| Property | Type | Required | Description |
|---|---|---|---|
| string | False |
UpdateVpcLinkInput
Represents the input parameters for an UpdateVpcLink request.
| Property | Type | Required | Description |
|---|---|---|---|
name | string | False | The name of the VPC link. |
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 | False | Tags for the VPC link. | |
vpcLinkId | string | True | The ID of the VPC link. |
vpcLinkStatus | False | The status of the VPC link. | |
vpcLinkStatusMessage | string | False | A message summarizing the cause of the status of the VPC link. |
vpcLinkVersion | False | The version of the VPC link. |
VpcLinkStatus
The status of the VPC link.
PENDINGAVAILABLEDELETINGFAILEDINACTIVE
VpcLinkVersion
The version of the VPC link.
V2