Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

UpdateVpcLink

Updates an existing VpcLink of a specified identifier.

Request Syntax


PATCH /vpclinks/vpclink_id HTTP/1.1
Content-type: application/json

{
   "patchOperations": [ 
      { 
         "from": "string",
         "op": "string",
         "path": "string",
         "value": "string"
      }
   ]
}

URI Request Parameters

The request uses the following URI parameters.

vpclink_id

The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.

Required: Yes

Request Body

The request accepts the following data in JSON format.

patchOperations

For more information about supported patch operations, see Patch Operations.

Type: Array of PatchOperation objects

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "description": "string",
   "id": "string",
   "name": "string",
   "status": "string",
   "statusMessage": "string",
   "tags": { 
      "string" : "string" 
   },
   "targetArns": [ "string" ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

description

The description of the VPC link.

Type: String

id

The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.

Type: String

name

The name used to label and identify the VPC link.

Type: String

status

The status of the VPC link. The valid values are AVAILABLE, PENDING, DELETING, or FAILED. Deploying an API will wait if the status is PENDING and will fail if the status is DELETING.

Type: String

Valid Values: AVAILABLE | PENDING | DELETING | FAILED

statusMessage

A description about the VPC link status.

Type: String

tags

The collection of tags. Each tag element is associated with a given resource.

Type: String to string map

targetArns

The ARN of the network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same AWS account of the API owner.

Type: Array of strings

Errors

For information about the errors that are common to all actions, see Common Errors.

BadRequestException

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

HTTP Status Code: 400

ConflictException

The request configuration has conflicts. For details, see the accompanying error message.

HTTP Status Code: 409

LimitExceededException

The request exceeded the rate limit. Retry after the specified time period.

HTTP Status Code: 429

NotFoundException

The requested resource is not found. Make sure that the request URI is correct.

HTTP Status Code: 404

TooManyRequestsException

The request has reached its throttling limit. Retry after the specified time period.

HTTP Status Code: 429

UnauthorizedException

The request is denied because the caller has insufficient permissions.

HTTP Status Code: 401