| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::IoT::TimestreamAction; | ||
| 3 | use Moose; | ||
| 4 | has DatabaseName => (is => 'ro', isa => 'Str', request_name => 'databaseName', traits => ['NameInRequest'], required => 1); | ||
| 5 | has Dimensions => (is => 'ro', isa => 'ArrayRef[Paws::IoT::TimestreamDimension]', request_name => 'dimensions', traits => ['NameInRequest'], required => 1); | ||
| 6 | has RoleArn => (is => 'ro', isa => 'Str', request_name => 'roleArn', traits => ['NameInRequest'], required => 1); | ||
| 7 | has TableName => (is => 'ro', isa => 'Str', request_name => 'tableName', traits => ['NameInRequest'], required => 1); | ||
| 8 | has Timestamp => (is => 'ro', isa => 'Paws::IoT::TimestreamTimestamp', request_name => 'timestamp', traits => ['NameInRequest']); | ||
| 9 | |||
| 10 | 1; | ||
| 11 | |||
| 12 | ### main pod documentation begin ### | ||
| 13 | |||
| 14 | =head1 NAME | ||
| 15 | |||
| 16 | Paws::IoT::TimestreamAction | ||
| 17 | |||
| 18 | =head1 USAGE | ||
| 19 | |||
| 20 | This class represents one of two things: | ||
| 21 | |||
| 22 | =head3 Arguments in a call to a service | ||
| 23 | |||
| 24 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 25 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 26 | |||
| 27 | As an example, if Att1 is expected to be a Paws::IoT::TimestreamAction object: | ||
| 28 | |||
| 29 | $service_obj->Method(Att1 => { DatabaseName => $value, ..., Timestamp => $value }); | ||
| 30 | |||
| 31 | =head3 Results returned from an API call | ||
| 32 | |||
| 33 | Use accessors for each attribute. If Att1 is expected to be an Paws::IoT::TimestreamAction object: | ||
| 34 | |||
| 35 | $result = $service_obj->Method(...); | ||
| 36 | $result->Att1->DatabaseName | ||
| 37 | |||
| 38 | =head1 DESCRIPTION | ||
| 39 | |||
| 40 | The Timestream rule action writes attributes (measures) from an MQTT | ||
| 41 | message into an Amazon Timestream table. For more information, see the | ||
| 42 | Timestream | ||
| 43 | (https://docs.aws.amazon.com/iot/latest/developerguide/timestream-rule-action.html) | ||
| 44 | topic rule action documentation. | ||
| 45 | |||
| 46 | =head1 ATTRIBUTES | ||
| 47 | |||
| 48 | |||
| 49 | =head2 B<REQUIRED> DatabaseName => Str | ||
| 50 | |||
| 51 | The name of an Amazon Timestream database. | ||
| 52 | |||
| 53 | |||
| 54 | =head2 B<REQUIRED> Dimensions => ArrayRef[L<Paws::IoT::TimestreamDimension>] | ||
| 55 | |||
| 56 | Metadata attributes of the time series that are written in each measure | ||
| 57 | record. | ||
| 58 | |||
| 59 | |||
| 60 | =head2 B<REQUIRED> RoleArn => Str | ||
| 61 | |||
| 62 | The ARN of the role that grants permission to write to the Amazon | ||
| 63 | Timestream database table. | ||
| 64 | |||
| 65 | |||
| 66 | =head2 B<REQUIRED> TableName => Str | ||
| 67 | |||
| 68 | The name of the database table into which to write the measure records. | ||
| 69 | |||
| 70 | |||
| 71 | =head2 Timestamp => L<Paws::IoT::TimestreamTimestamp> | ||
| 72 | |||
| 73 | Specifies an application-defined value to replace the default value | ||
| 74 | assigned to the Timestream record's timestamp in the C<time> column. | ||
| 75 | |||
| 76 | You can use this property to specify the value and the precision of the | ||
| 77 | Timestream record's timestamp. You can specify a value from the message | ||
| 78 | payload or a value computed by a substitution template. | ||
| 79 | |||
| 80 | If omitted, the topic rule action assigns the timestamp, in | ||
| 81 | milliseconds, at the time it processed the rule. | ||
| 82 | |||
| 83 | |||
| 84 | |||
| 85 | =head1 SEE ALSO | ||
| 86 | |||
| 87 | This class forms part of L<Paws>, describing an object used in L<Paws::IoT> | ||
| 88 | |||
| 89 | =head1 BUGS and CONTRIBUTIONS | ||
| 90 | |||
| 91 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 92 | |||
| 93 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 94 | |||
| 95 | =cut | ||
| 96 |