AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

PatchOperation

import "github.com/aws/aws-sdk-go/service/apigateway"

type PatchOperation struct { From *string `locationName:"from" type:"string"` Op *string `locationName:"op" type:"string" enum:"Op"` Path *string `locationName:"path" type:"string"` Value *string `locationName:"value" type:"string"` }

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

From

Type: *string

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".

Op

Type: *string

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.

Path

Type: *string

The op operation's target, as identified by a JSON Pointer (https://tools.ietf.org/html/draft-ietf-appsawg-json-pointer-08) 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., {"name": {"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.

Value

Type: *string

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., '{"a": ...}'. In a Windows shell, see Using JSON for Parameters (https://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json).

Method

GoString

func (s PatchOperation) GoString() string

GoString returns the string representation

SetFrom

func (s *PatchOperation) SetFrom(v string) *PatchOperation

SetFrom sets the From field's value.

SetOp

func (s *PatchOperation) SetOp(v string) *PatchOperation

SetOp sets the Op field's value.

SetPath

func (s *PatchOperation) SetPath(v string) *PatchOperation

SetPath sets the Path field's value.

SetValue

func (s *PatchOperation) SetValue(v string) *PatchOperation

SetValue sets the Value field's value.

String

func (s PatchOperation) String() string

String returns the string representation

On this page: