« blib/lib/Paws/IoTAnalytics/DatasetTrigger.pm
↑ Summary
blib/lib/Paws/IoTAnalytics/DatastoreActivity.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::IoTAnalytics::Datastore; | ||
| 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 DatastorePartitions => (is => 'ro', isa => 'Paws::IoTAnalytics::DatastorePartitions', request_name => 'datastorePartitions', traits => ['NameInRequest']); | ||
| 7 | has FileFormatConfiguration => (is => 'ro', isa => 'Paws::IoTAnalytics::FileFormatConfiguration', request_name => 'fileFormatConfiguration', traits => ['NameInRequest']); | ||
| 8 | has LastMessageArrivalTime => (is => 'ro', isa => 'Str', request_name => 'lastMessageArrivalTime', traits => ['NameInRequest']); | ||
| 9 | has LastUpdateTime => (is => 'ro', isa => 'Str', request_name => 'lastUpdateTime', traits => ['NameInRequest']); | ||
| 10 | has Name => (is => 'ro', isa => 'Str', request_name => 'name', traits => ['NameInRequest']); | ||
| 11 | has RetentionPeriod => (is => 'ro', isa => 'Paws::IoTAnalytics::RetentionPeriod', request_name => 'retentionPeriod', traits => ['NameInRequest']); | ||
| 12 | has Status => (is => 'ro', isa => 'Str', request_name => 'status', traits => ['NameInRequest']); | ||
| 13 | has Storage => (is => 'ro', isa => 'Paws::IoTAnalytics::DatastoreStorage', request_name => 'storage', traits => ['NameInRequest']); | ||
| 14 | |||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::IoTAnalytics::Datastore | ||
| 22 | |||
| 23 | =head1 USAGE | ||
| 24 | |||
| 25 | This class represents one of two things: | ||
| 26 | |||
| 27 | =head3 Arguments in a call to a service | ||
| 28 | |||
| 29 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 30 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 31 | |||
| 32 | As an example, if Att1 is expected to be a Paws::IoTAnalytics::Datastore object: | ||
| 33 | |||
| 34 | $service_obj->Method(Att1 => { Arn => $value, ..., Storage => $value }); | ||
| 35 | |||
| 36 | =head3 Results returned from an API call | ||
| 37 | |||
| 38 | Use accessors for each attribute. If Att1 is expected to be an Paws::IoTAnalytics::Datastore object: | ||
| 39 | |||
| 40 | $result = $service_obj->Method(...); | ||
| 41 | $result->Att1->Arn | ||
| 42 | |||
| 43 | =head1 DESCRIPTION | ||
| 44 | |||
| 45 | Information about a data store. | ||
| 46 | |||
| 47 | =head1 ATTRIBUTES | ||
| 48 | |||
| 49 | |||
| 50 | =head2 Arn => Str | ||
| 51 | |||
| 52 | The ARN of the data store. | ||
| 53 | |||
| 54 | |||
| 55 | =head2 CreationTime => Str | ||
| 56 | |||
| 57 | When the data store was created. | ||
| 58 | |||
| 59 | |||
| 60 | =head2 DatastorePartitions => L<Paws::IoTAnalytics::DatastorePartitions> | ||
| 61 | |||
| 62 | Contains information about the partitions in a data store. | ||
| 63 | |||
| 64 | |||
| 65 | =head2 FileFormatConfiguration => L<Paws::IoTAnalytics::FileFormatConfiguration> | ||
| 66 | |||
| 67 | Contains the configuration information of file formats. AWS IoT | ||
| 68 | Analytics data stores support JSON and Parquet | ||
| 69 | (https://parquet.apache.org/). | ||
| 70 | |||
| 71 | The default file format is JSON. You can specify only one format. | ||
| 72 | |||
| 73 | You can't change the file format after you create the data store. | ||
| 74 | |||
| 75 | |||
| 76 | =head2 LastMessageArrivalTime => Str | ||
| 77 | |||
| 78 | The last time when a new message arrived in the data store. | ||
| 79 | |||
| 80 | AWS IoT Analytics updates this value at most once per minute for one | ||
| 81 | data store. Hence, the C<lastMessageArrivalTime> value is an | ||
| 82 | approximation. | ||
| 83 | |||
| 84 | This feature only applies to messages that arrived in the data store | ||
| 85 | after October 23, 2020. | ||
| 86 | |||
| 87 | |||
| 88 | =head2 LastUpdateTime => Str | ||
| 89 | |||
| 90 | The last time the data store was updated. | ||
| 91 | |||
| 92 | |||
| 93 | =head2 Name => Str | ||
| 94 | |||
| 95 | The name of the data store. | ||
| 96 | |||
| 97 | |||
| 98 | =head2 RetentionPeriod => L<Paws::IoTAnalytics::RetentionPeriod> | ||
| 99 | |||
| 100 | How long, in days, message data is kept for the data store. When | ||
| 101 | C<customerManagedS3> storage is selected, this parameter is ignored. | ||
| 102 | |||
| 103 | |||
| 104 | =head2 Status => Str | ||
| 105 | |||
| 106 | The status of a data store: | ||
| 107 | |||
| 108 | =over | ||
| 109 | |||
| 110 | =item CREATING | ||
| 111 | |||
| 112 | The data store is being created. | ||
| 113 | |||
| 114 | =item ACTIVE | ||
| 115 | |||
| 116 | The data store has been created and can be used. | ||
| 117 | |||
| 118 | =item DELETING | ||
| 119 | |||
| 120 | The data store is being deleted. | ||
| 121 | |||
| 122 | =back | ||
| 123 | |||
| 124 | |||
| 125 | |||
| 126 | =head2 Storage => L<Paws::IoTAnalytics::DatastoreStorage> | ||
| 127 | |||
| 128 | Where data store data is stored. You can choose one of | ||
| 129 | C<serviceManagedS3> or C<customerManagedS3> storage. If not specified, | ||
| 130 | the default is C<serviceManagedS3>. You cannot change this storage | ||
| 131 | option after the data store is created. | ||
| 132 | |||
| 133 | |||
| 134 | |||
| 135 | =head1 SEE ALSO | ||
| 136 | |||
| 137 | This class forms part of L<Paws>, describing an object used in L<Paws::IoTAnalytics> | ||
| 138 | |||
| 139 | =head1 BUGS and CONTRIBUTIONS | ||
| 140 | |||
| 141 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 142 | |||
| 143 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 144 | |||
| 145 | =cut | ||
| 146 |