vpclink:update
Updates an existing VpcLink of a specified identifier.
HTTP Request
PATCH /vpclinks/<vpclink_id>
Request Body
{
"patchOperations" : [ {
"op" : "String",
"path" : "String",
"value" : "String",
"from" : "String"
} ]
}
Request Body Fields
The request accepts the following fields in JSON format.
- patchOperations
A list of update operations to be applied to the specified resource and in the order specified in this list.
- op
An update operation to be performed with this PATCH request. The valid value can be
add
,remove
,replace
orcopy
. Not all valid operations are supported for a given resource. Support of the operations depends on specific operational contexts. Attempts to apply an unsupported operation on a resource will return an error message.- path
The
op
operation's target, as identified by a JSON Pointer value that references a location within the targeted resource. For example, if the target resource has an updateable property of{"name":"value"}
, the path for this property is/name
. If thename
property value is a JSON object (e.g.,{"name": {"child/name": "child-value"}}
), the path for thechild/name
property will be/name/child~1name
. Any slash ("/") character appearing in path names must be escaped with "~1", as shown in the example above. Eachop
operation can have only onepath
associated with it.- value
The new target value of the update operation. It is applicable for the
add
orreplace
operation. When using AWS CLI to update a property of a JSON value, enclose the JSON object with a pair of single quotes in a Linux shell, e.g., '{"a": ...}'. In a Windows shell, see Using JSON for Parameters.- from
The
copy
update operation's source as identified by aJSON-Pointer
value referencing the location within the targeted resource to copy the value from. For example, to promote a canary deployment, you copy the canary deployment ID to the affiliated deployment ID by calling a PATCH request on a Stage resource with"op":"copy"
,"from":"/canarySettings/deploymentId"
and"path":"/deploymentId"
.
Response
Remarks
The following table shows the supported and unsupported op
operations for updateable properties of VpcLink as the path
values.
path |
op:add |
op:replace |
op:remove |
op:copy |
---|---|---|---|---|
/name |
Not supported | Supported | Not supported | Not supported |
/description |
Not supported | Supported | Not supported | Not supported |