# PatchOperation
<a name="API_PatchOperation"></a>

For more information about supported patch operations, see [Patch Operations](patch-operations.md).

## Contents
<a name="API_PatchOperation_Contents"></a>

 ** from **   <a name="apigw-Type-PatchOperation-from"></a>
The copy update operation's source as identified by a JSON-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".  
Type: String  
Required: No

 ** op **   <a name="apigw-Type-PatchOperation-op"></a>
An update operation to be performed with this PATCH request. The valid value can be add, remove, replace or copy. 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..  
Type: String  
Valid Values: `add | remove | replace | move | copy | test`   
Required: No

 ** path **   <a name="apigw-Type-PatchOperation-path"></a>
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 \$1"name":"value"\$1, the path for this property is /name. If the name property value is a JSON object (e.g., \$1"name": \$1"child/name": "child-value"\$1\$1), the path for the child/name property will be /name/child\$11name. Any slash ("/") character appearing in path names must be escaped with "\$11", as shown in the example above. Each op operation can have only one path associated with it.  
Type: String  
Required: No

 ** value **   <a name="apigw-Type-PatchOperation-value"></a>
The new target value of the update operation. It is applicable for the add or replace 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., '\$1"a": ...\$1'.  
Type: String  
Required: No

## See Also
<a name="API_PatchOperation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/PatchOperation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/PatchOperation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/PatchOperation)