Amazonka.APIGateway.Types.PatchOperation

Documentation

data PatchOperation

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

See: newPatchOperation smart constructor.

Constructors

PatchOperation'

Fields

• from :: Maybe Text

  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 :: Maybe Op

  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 :: Maybe Text

  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., {"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 :: Maybe Text

  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": ...}'.

Instances

ToJSON PatchOperation

Defined in Amazonka.APIGateway.Types.PatchOperation

Methods

toJSON :: PatchOperation -> Value

toEncoding :: PatchOperation -> Encoding

toJSONList :: [PatchOperation] -> Value

toEncodingList :: [PatchOperation] -> Encoding

Generic PatchOperation

Defined in Amazonka.APIGateway.Types.PatchOperation

Associated Types

type Rep PatchOperation :: Type -> Type

Methods

from :: PatchOperation -> Rep PatchOperation x

to :: Rep PatchOperation x -> PatchOperation

Read PatchOperation

Defined in Amazonka.APIGateway.Types.PatchOperation

Methods

readsPrec :: Int -> ReadS PatchOperation

readList :: ReadS [PatchOperation]

readPrec :: ReadPrec PatchOperation

readListPrec :: ReadPrec [PatchOperation]

Show PatchOperation

Defined in Amazonka.APIGateway.Types.PatchOperation

Methods

showsPrec :: Int -> PatchOperation -> ShowS

show :: PatchOperation -> String

showList :: [PatchOperation] -> ShowS

NFData PatchOperation

Defined in Amazonka.APIGateway.Types.PatchOperation

Methods

rnf :: PatchOperation -> ()

Eq PatchOperation

Defined in Amazonka.APIGateway.Types.PatchOperation

Methods

(==) :: PatchOperation -> PatchOperation -> Bool

(/=) :: PatchOperation -> PatchOperation -> Bool

Hashable PatchOperation

Defined in Amazonka.APIGateway.Types.PatchOperation

Methods

hashWithSalt :: Int -> PatchOperation -> Int

hash :: PatchOperation -> Int

type Rep PatchOperation

Defined in Amazonka.APIGateway.Types.PatchOperation

type Rep PatchOperation = D1 ('MetaData "PatchOperation" "Amazonka.APIGateway.Types.PatchOperation" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "PatchOperation'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "from") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "op") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Op))) :*: (S1 ('MetaSel ('Just "path") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newPatchOperation :: PatchOperation

Create a value of PatchOperation with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:from:PatchOperation', patchOperation_from - 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".

$sel:op:PatchOperation', patchOperation_op - 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..

$sel:path:PatchOperation', patchOperation_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 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.

$sel:value:PatchOperation', patchOperation_value - 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": ...}'.

patchOperation_from :: Lens' PatchOperation (Maybe Text)

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

patchOperation_op :: Lens' PatchOperation (Maybe Op)

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

patchOperation_path :: Lens' PatchOperation (Maybe Text)

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

patchOperation_value :: Lens' PatchOperation (Maybe Text)

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": ...}'.