Class: Aws::APIGateway::Types::PatchOperation

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-apigateway/types.rb

Overview

Note:

When making an API call, you may pass PatchOperation data as a hash:

{
  op: "add", # accepts add, remove, replace, move, copy, test
  path: "String",
  value: "String",
  from: "String",
}

A single patch operation to apply to the specified resource. Please refer to tools.ietf.org/html/rfc6902#section-4 for an explanation of how each operation is used.

Instance Attribute Summary collapse

Instance Attribute Details

#from ⇒ String

Not supported.

Returns:

  • (String) 


4568
4569
4570
4571
4572
4573
4574
 
# File 'lib/aws-sdk-apigateway/types.rb', line 4568

class PatchOperation < Struct.new(
  :op,
  :path,
  :value,
  :from)
  include Aws::Structure
end

#op ⇒ String

An update operation to be performed with this PATCH request. The valid value can be “add”, “remove”, or “replace”. 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.

Returns:

  • (String) 


4568
4569
4570
4571
4572
4573
4574
 
# File 'lib/aws-sdk-apigateway/types.rb', line 4568

class PatchOperation < Struct.new(
  :op,
  :path,
  :value,
  :from)
  include Aws::Structure
end

#path ⇒ String

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 the `name` property value is a JSON object (e.g., `{“child/name”: “child-value”}`), the path for the `child/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. Each `op` operation can have only one `path` associated with it.

[1]: tools.ietf.org/html/draft-ietf-appsawg-json-pointer-08

Returns:

  • (String) 


4568
4569
4570
4571
4572
4573
4574
 
# File 'lib/aws-sdk-apigateway/types.rb', line 4568

class PatchOperation < Struct.new(
  :op,
  :path,
  :value,
  :from)
  include Aws::Structure
end

#value ⇒ String

The new target value of the update 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].

[1]: docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json

Returns:

  • (String) 


4568
4569
4570
4571
4572
4573
4574
 
# File 'lib/aws-sdk-apigateway/types.rb', line 4568

class PatchOperation < Struct.new(
  :op,
  :path,
  :value,
  :from)
  include Aws::Structure
end