« blib/lib/Paws/IoTEvents/OnInputLifecycle.pm
↑ Summary
blib/lib/Paws/IoTEvents/PutLoggingOptions.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::IoTEvents::Payload; | ||
| 3 | use Moose; | ||
| 4 | has ContentExpression => (is => 'ro', isa => 'Str', request_name => 'contentExpression', traits => ['NameInRequest'], required => 1); | ||
| 5 | has Type => (is => 'ro', isa => 'Str', request_name => 'type', traits => ['NameInRequest'], required => 1); | ||
| 6 | |||
| 7 | 1; | ||
| 8 | |||
| 9 | ### main pod documentation begin ### | ||
| 10 | |||
| 11 | =head1 NAME | ||
| 12 | |||
| 13 | Paws::IoTEvents::Payload | ||
| 14 | |||
| 15 | =head1 USAGE | ||
| 16 | |||
| 17 | This class represents one of two things: | ||
| 18 | |||
| 19 | =head3 Arguments in a call to a service | ||
| 20 | |||
| 21 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 22 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 23 | |||
| 24 | As an example, if Att1 is expected to be a Paws::IoTEvents::Payload object: | ||
| 25 | |||
| 26 | $service_obj->Method(Att1 => { ContentExpression => $value, ..., Type => $value }); | ||
| 27 | |||
| 28 | =head3 Results returned from an API call | ||
| 29 | |||
| 30 | Use accessors for each attribute. If Att1 is expected to be an Paws::IoTEvents::Payload object: | ||
| 31 | |||
| 32 | $result = $service_obj->Method(...); | ||
| 33 | $result->Att1->ContentExpression | ||
| 34 | |||
| 35 | =head1 DESCRIPTION | ||
| 36 | |||
| 37 | Information needed to configure the payload. | ||
| 38 | |||
| 39 | By default, AWS IoT Events generates a standard payload in JSON for any | ||
| 40 | action. This action payload contains all attribute-value pairs that | ||
| 41 | have the information about the detector model instance and the event | ||
| 42 | triggered the action. To configure the action payload, you can use | ||
| 43 | C<contentExpression>. | ||
| 44 | |||
| 45 | =head1 ATTRIBUTES | ||
| 46 | |||
| 47 | |||
| 48 | =head2 B<REQUIRED> ContentExpression => Str | ||
| 49 | |||
| 50 | The content of the payload. You can use a string expression that | ||
| 51 | includes quoted strings (C<'E<lt>stringE<gt>'>), variables | ||
| 52 | (C<$variable.E<lt>variable-nameE<gt>>), input values | ||
| 53 | (C<$input.E<lt>input-nameE<gt>.E<lt>path-to-datumE<gt>>), string | ||
| 54 | concatenations, and quoted strings that contain C<${}> as the content. | ||
| 55 | The recommended maximum size of a content expression is 1 KB. | ||
| 56 | |||
| 57 | |||
| 58 | =head2 B<REQUIRED> Type => Str | ||
| 59 | |||
| 60 | The value of the payload type can be either C<STRING> or C<JSON>. | ||
| 61 | |||
| 62 | |||
| 63 | |||
| 64 | =head1 SEE ALSO | ||
| 65 | |||
| 66 | This class forms part of L<Paws>, describing an object used in L<Paws::IoTEvents> | ||
| 67 | |||
| 68 | =head1 BUGS and CONTRIBUTIONS | ||
| 69 | |||
| 70 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 71 | |||
| 72 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 73 | |||
| 74 | =cut | ||
| 75 |