« blib/lib/Paws/IoTEvents/AssetPropertyVariant.pm
↑ Summary
blib/lib/Paws/IoTEvents/ClearTimerAction.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::IoTEvents::Attribute; | ||
| 3 | use Moose; | ||
| 4 | has JsonPath => (is => 'ro', isa => 'Str', request_name => 'jsonPath', traits => ['NameInRequest'], required => 1); | ||
| 5 | |||
| 6 | 1; | ||
| 7 | |||
| 8 | ### main pod documentation begin ### | ||
| 9 | |||
| 10 | =head1 NAME | ||
| 11 | |||
| 12 | Paws::IoTEvents::Attribute | ||
| 13 | |||
| 14 | =head1 USAGE | ||
| 15 | |||
| 16 | This class represents one of two things: | ||
| 17 | |||
| 18 | =head3 Arguments in a call to a service | ||
| 19 | |||
| 20 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 21 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 22 | |||
| 23 | As an example, if Att1 is expected to be a Paws::IoTEvents::Attribute object: | ||
| 24 | |||
| 25 | $service_obj->Method(Att1 => { JsonPath => $value, ..., JsonPath => $value }); | ||
| 26 | |||
| 27 | =head3 Results returned from an API call | ||
| 28 | |||
| 29 | Use accessors for each attribute. If Att1 is expected to be an Paws::IoTEvents::Attribute object: | ||
| 30 | |||
| 31 | $result = $service_obj->Method(...); | ||
| 32 | $result->Att1->JsonPath | ||
| 33 | |||
| 34 | =head1 DESCRIPTION | ||
| 35 | |||
| 36 | The attributes from the JSON payload that are made available by the | ||
| 37 | input. Inputs are derived from messages sent to the AWS IoT Events | ||
| 38 | system using C<BatchPutMessage>. Each such message contains a JSON | ||
| 39 | payload. Those attributes (and their paired values) specified here are | ||
| 40 | available for use in the C<condition> expressions used by detectors. | ||
| 41 | |||
| 42 | =head1 ATTRIBUTES | ||
| 43 | |||
| 44 | |||
| 45 | =head2 B<REQUIRED> JsonPath => Str | ||
| 46 | |||
| 47 | An expression that specifies an attribute-value pair in a JSON | ||
| 48 | structure. Use this to specify an attribute from the JSON payload that | ||
| 49 | is made available by the input. Inputs are derived from messages sent | ||
| 50 | to AWS IoT Events (C<BatchPutMessage>). Each such message contains a | ||
| 51 | JSON payload. The attribute (and its paired value) specified here are | ||
| 52 | available for use in the C<condition> expressions used by detectors. | ||
| 53 | |||
| 54 | Syntax: C<E<lt>field-nameE<gt>.E<lt>field-nameE<gt>...> | ||
| 55 | |||
| 56 | |||
| 57 | |||
| 58 | =head1 SEE ALSO | ||
| 59 | |||
| 60 | This class forms part of L<Paws>, describing an object used in L<Paws::IoTEvents> | ||
| 61 | |||
| 62 | =head1 BUGS and CONTRIBUTIONS | ||
| 63 | |||
| 64 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 65 | |||
| 66 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 67 | |||
| 68 | =cut | ||
| 69 |