« blib/lib/Paws/IoTAnalytics/CancelPipelineReprocessingResponse.pm
↑ Summary
blib/lib/Paws/IoTAnalytics/ChannelActivity.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::IoTAnalytics::Channel; | ||
| 3 | use Moose; | ||
| 4 | has Arn => (is => 'ro', isa => 'Str', request_name => 'arn', traits => ['NameInRequest']); | ||
| 5 | has CreationTime => (is => 'ro', isa => 'Str', request_name => 'creationTime', traits => ['NameInRequest']); | ||
| 6 | has LastMessageArrivalTime => (is => 'ro', isa => 'Str', request_name => 'lastMessageArrivalTime', traits => ['NameInRequest']); | ||
| 7 | has LastUpdateTime => (is => 'ro', isa => 'Str', request_name => 'lastUpdateTime', traits => ['NameInRequest']); | ||
| 8 | has Name => (is => 'ro', isa => 'Str', request_name => 'name', traits => ['NameInRequest']); | ||
| 9 | has RetentionPeriod => (is => 'ro', isa => 'Paws::IoTAnalytics::RetentionPeriod', request_name => 'retentionPeriod', traits => ['NameInRequest']); | ||
| 10 | has Status => (is => 'ro', isa => 'Str', request_name => 'status', traits => ['NameInRequest']); | ||
| 11 | has Storage => (is => 'ro', isa => 'Paws::IoTAnalytics::ChannelStorage', request_name => 'storage', traits => ['NameInRequest']); | ||
| 12 | |||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::IoTAnalytics::Channel | ||
| 20 | |||
| 21 | =head1 USAGE | ||
| 22 | |||
| 23 | This class represents one of two things: | ||
| 24 | |||
| 25 | =head3 Arguments in a call to a service | ||
| 26 | |||
| 27 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 28 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 29 | |||
| 30 | As an example, if Att1 is expected to be a Paws::IoTAnalytics::Channel object: | ||
| 31 | |||
| 32 | $service_obj->Method(Att1 => { Arn => $value, ..., Storage => $value }); | ||
| 33 | |||
| 34 | =head3 Results returned from an API call | ||
| 35 | |||
| 36 | Use accessors for each attribute. If Att1 is expected to be an Paws::IoTAnalytics::Channel object: | ||
| 37 | |||
| 38 | $result = $service_obj->Method(...); | ||
| 39 | $result->Att1->Arn | ||
| 40 | |||
| 41 | =head1 DESCRIPTION | ||
| 42 | |||
| 43 | A collection of data from an MQTT topic. Channels archive the raw, | ||
| 44 | unprocessed messages before publishing the data to a pipeline. | ||
| 45 | |||
| 46 | =head1 ATTRIBUTES | ||
| 47 | |||
| 48 | |||
| 49 | =head2 Arn => Str | ||
| 50 | |||
| 51 | The ARN of the channel. | ||
| 52 | |||
| 53 | |||
| 54 | =head2 CreationTime => Str | ||
| 55 | |||
| 56 | When the channel was created. | ||
| 57 | |||
| 58 | |||
| 59 | =head2 LastMessageArrivalTime => Str | ||
| 60 | |||
| 61 | The last time when a new message arrived in the channel. | ||
| 62 | |||
| 63 | AWS IoT Analytics updates this value at most once per minute for one | ||
| 64 | channel. Hence, the C<lastMessageArrivalTime> value is an | ||
| 65 | approximation. | ||
| 66 | |||
| 67 | This feature only applies to messages that arrived in the data store | ||
| 68 | after October 23, 2020. | ||
| 69 | |||
| 70 | |||
| 71 | =head2 LastUpdateTime => Str | ||
| 72 | |||
| 73 | When the channel was last updated. | ||
| 74 | |||
| 75 | |||
| 76 | =head2 Name => Str | ||
| 77 | |||
| 78 | The name of the channel. | ||
| 79 | |||
| 80 | |||
| 81 | =head2 RetentionPeriod => L<Paws::IoTAnalytics::RetentionPeriod> | ||
| 82 | |||
| 83 | How long, in days, message data is kept for the channel. | ||
| 84 | |||
| 85 | |||
| 86 | =head2 Status => Str | ||
| 87 | |||
| 88 | The status of the channel. | ||
| 89 | |||
| 90 | |||
| 91 | =head2 Storage => L<Paws::IoTAnalytics::ChannelStorage> | ||
| 92 | |||
| 93 | Where channel data is stored. You can choose one of C<serviceManagedS3> | ||
| 94 | or C<customerManagedS3> storage. If not specified, the default is | ||
| 95 | C<serviceManagedS3>. You cannot change this storage option after the | ||
| 96 | channel is created. | ||
| 97 | |||
| 98 | |||
| 99 | |||
| 100 | =head1 SEE ALSO | ||
| 101 | |||
| 102 | This class forms part of L<Paws>, describing an object used in L<Paws::IoTAnalytics> | ||
| 103 | |||
| 104 | =head1 BUGS and CONTRIBUTIONS | ||
| 105 | |||
| 106 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 107 | |||
| 108 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 109 | |||
| 110 | =cut | ||
| 111 |