« blib/lib/Paws/ApiGateway/MutualTlsAuthenticationInput.pm
↑ Summary
blib/lib/Paws/ApiGateway/PathToMapOfMethodSnapshot.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::ApiGateway::PatchOperation; | ||
| 3 | use Moose; | ||
| 4 | has From => (is => 'ro', isa => 'Str', request_name => 'from', traits => ['NameInRequest']); | ||
| 5 | has Op => (is => 'ro', isa => 'Str', request_name => 'op', traits => ['NameInRequest']); | ||
| 6 | has Path => (is => 'ro', isa => 'Str', request_name => 'path', traits => ['NameInRequest']); | ||
| 7 | has Value => (is => 'ro', isa => 'Str', request_name => 'value', traits => ['NameInRequest']); | ||
| 8 | |||
| 9 | 1; | ||
| 10 | |||
| 11 | ### main pod documentation begin ### | ||
| 12 | |||
| 13 | =head1 NAME | ||
| 14 | |||
| 15 | Paws::ApiGateway::PatchOperation | ||
| 16 | |||
| 17 | =head1 USAGE | ||
| 18 | |||
| 19 | This class represents one of two things: | ||
| 20 | |||
| 21 | =head3 Arguments in a call to a service | ||
| 22 | |||
| 23 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 24 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 25 | |||
| 26 | As an example, if Att1 is expected to be a Paws::ApiGateway::PatchOperation object: | ||
| 27 | |||
| 28 | $service_obj->Method(Att1 => { From => $value, ..., Value => $value }); | ||
| 29 | |||
| 30 | =head3 Results returned from an API call | ||
| 31 | |||
| 32 | Use accessors for each attribute. If Att1 is expected to be an Paws::ApiGateway::PatchOperation object: | ||
| 33 | |||
| 34 | $result = $service_obj->Method(...); | ||
| 35 | $result->Att1->From | ||
| 36 | |||
| 37 | =head1 DESCRIPTION | ||
| 38 | |||
| 39 | A single patch operation to apply to the specified resource. Please | ||
| 40 | refer to http://tools.ietf.org/html/rfc6902#section-4 for an | ||
| 41 | explanation of how each operation is used. | ||
| 42 | |||
| 43 | =head1 ATTRIBUTES | ||
| 44 | |||
| 45 | |||
| 46 | =head2 From => Str | ||
| 47 | |||
| 48 | The C<copy> update operation's source as identified by a | ||
| 49 | C<JSON-Pointer> value referencing the location within the targeted | ||
| 50 | resource to copy the value from. For example, to promote a canary | ||
| 51 | deployment, you copy the canary deployment ID to the affiliated | ||
| 52 | deployment ID by calling a PATCH request on a Stage resource with | ||
| 53 | C<"op":"copy">, C<"from":"/canarySettings/deploymentId"> and | ||
| 54 | C<"path":"/deploymentId">. | ||
| 55 | |||
| 56 | |||
| 57 | =head2 Op => Str | ||
| 58 | |||
| 59 | An update operation to be performed with this PATCH request. The valid | ||
| 60 | value can be C<add>, C<remove>, C<replace> or C<copy>. Not all valid | ||
| 61 | operations are supported for a given resource. Support of the | ||
| 62 | operations depends on specific operational contexts. Attempts to apply | ||
| 63 | an unsupported operation on a resource will return an error message. | ||
| 64 | |||
| 65 | |||
| 66 | =head2 Path => Str | ||
| 67 | |||
| 68 | The C<op> operation's target, as identified by a JSON Pointer | ||
| 69 | (https://tools.ietf.org/html/draft-ietf-appsawg-json-pointer-08) value | ||
| 70 | that references a location within the targeted resource. For example, | ||
| 71 | if the target resource has an updateable property of | ||
| 72 | C<{"name":"value"}>, the path for this property is C</name>. If the | ||
| 73 | C<name> property value is a JSON object (e.g., C<{"name": | ||
| 74 | {"child/name": "child-value"}}>), the path for the C<child/name> | ||
| 75 | property will be C</name/child~1name>. Any slash ("/") character | ||
| 76 | appearing in path names must be escaped with "~1", as shown in the | ||
| 77 | example above. Each C<op> operation can have only one C<path> | ||
| 78 | associated with it. | ||
| 79 | |||
| 80 | |||
| 81 | =head2 Value => Str | ||
| 82 | |||
| 83 | The new target value of the update operation. It is applicable for the | ||
| 84 | C<add> or C<replace> operation. When using AWS CLI to update a property | ||
| 85 | of a JSON value, enclose the JSON object with a pair of single quotes | ||
| 86 | in a Linux shell, e.g., '{"a": ...}'. In a Windows shell, see Using | ||
| 87 | JSON for Parameters | ||
| 88 | (https://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json). | ||
| 89 | |||
| 90 | |||
| 91 | |||
| 92 | =head1 SEE ALSO | ||
| 93 | |||
| 94 | This class forms part of L<Paws>, describing an object used in L<Paws::ApiGateway> | ||
| 95 | |||
| 96 | =head1 BUGS and CONTRIBUTIONS | ||
| 97 | |||
| 98 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 99 | |||
| 100 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 101 | |||
| 102 | =cut | ||
| 103 |