-
Notifications
You must be signed in to change notification settings - Fork 602
/
types.go
1538 lines (1156 loc) · 42.7 KB
/
types.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Code generated by smithy-go-codegen DO NOT EDIT.
package types
import (
smithydocument "github.com/aws/smithy-go/document"
"time"
)
// An activity that adds other attributes based on existing attributes in the
// message.
type AddAttributesActivity struct {
// A list of 1-50 AttributeNameMapping objects that map an existing attribute to a
// new attribute.
//
// The existing attributes remain in the message, so if you want to remove the
// originals, use RemoveAttributeActivity .
//
// This member is required.
Attributes map[string]string
// The name of the addAttributes activity.
//
// This member is required.
Name *string
// The next activity in the pipeline.
Next *string
noSmithyDocumentSerde
}
// Contains informations about errors.
type BatchPutMessageErrorEntry struct {
// The code associated with the error.
ErrorCode *string
// The message associated with the error.
ErrorMessage *string
// The ID of the message that caused the error. See the value corresponding to the
// messageId key in the message object.
MessageId *string
noSmithyDocumentSerde
}
// A collection of data from an MQTT topic. Channels archive the raw, unprocessed
// messages before publishing the data to a pipeline.
type Channel struct {
// The ARN of the channel.
Arn *string
// When the channel was created.
CreationTime *time.Time
// The last time when a new message arrived in the channel.
//
// IoT Analytics updates this value at most once per minute for one channel.
// Hence, the lastMessageArrivalTime value is an approximation.
//
// This feature only applies to messages that arrived in the data store after
// October 23, 2020.
LastMessageArrivalTime *time.Time
// When the channel was last updated.
LastUpdateTime *time.Time
// The name of the channel.
Name *string
// How long, in days, message data is kept for the channel.
RetentionPeriod *RetentionPeriod
// The status of the channel.
Status ChannelStatus
// Where channel data is stored. You can choose one of serviceManagedS3 or
// customerManagedS3 storage. If not specified, the default is serviceManagedS3 .
// You can't change this storage option after the channel is created.
Storage *ChannelStorage
noSmithyDocumentSerde
}
// The activity that determines the source of the messages to be processed.
type ChannelActivity struct {
// The name of the channel from which the messages are processed.
//
// This member is required.
ChannelName *string
// The name of the channel activity.
//
// This member is required.
Name *string
// The next activity in the pipeline.
Next *string
noSmithyDocumentSerde
}
// Specifies one or more sets of channel messages.
type ChannelMessages struct {
// Specifies one or more keys that identify the Amazon Simple Storage Service
// (Amazon S3) objects that save your channel messages.
//
// You must use the full path for the key.
//
// Example path: channel/mychannel/__dt=2020-02-29
// 00:00:00/1582940490000_1582940520000_123456789012_mychannel_0_2118.0.json.gz
S3Paths []string
noSmithyDocumentSerde
}
// Statistics information about the channel.
type ChannelStatistics struct {
// The estimated size of the channel.
Size *EstimatedResourceSize
noSmithyDocumentSerde
}
// Where channel data is stored. You may choose one of serviceManagedS3 ,
// customerManagedS3 storage. If not specified, the default is serviceManagedS3 .
// This can't be changed after creation of the channel.
type ChannelStorage struct {
// Used to store channel data in an S3 bucket that you manage. If customer managed
// storage is selected, the retentionPeriod parameter is ignored. You can't change
// the choice of S3 storage after the data store is created.
CustomerManagedS3 *CustomerManagedChannelS3Storage
// Used to store channel data in an S3 bucket managed by IoT Analytics. You can't
// change the choice of S3 storage after the data store is created.
ServiceManagedS3 *ServiceManagedChannelS3Storage
noSmithyDocumentSerde
}
// Where channel data is stored.
type ChannelStorageSummary struct {
// Used to store channel data in an S3 bucket that you manage.
CustomerManagedS3 *CustomerManagedChannelS3StorageSummary
// Used to store channel data in an S3 bucket managed by IoT Analytics.
ServiceManagedS3 *ServiceManagedChannelS3StorageSummary
noSmithyDocumentSerde
}
// A summary of information about a channel.
type ChannelSummary struct {
// The name of the channel.
ChannelName *string
// Where channel data is stored.
ChannelStorage *ChannelStorageSummary
// When the channel was created.
CreationTime *time.Time
// The last time when a new message arrived in the channel.
//
// IoT Analytics updates this value at most once per minute for one channel.
// Hence, the lastMessageArrivalTime value is an approximation.
//
// This feature only applies to messages that arrived in the data store after
// October 23, 2020.
LastMessageArrivalTime *time.Time
// The last time the channel was updated.
LastUpdateTime *time.Time
// The status of the channel.
Status ChannelStatus
noSmithyDocumentSerde
}
// Contains information about a column that stores your data.
type Column struct {
// The name of the column.
//
// This member is required.
Name *string
// The type of data. For more information about the supported data types, see [Common data types] in
// the Glue Developer Guide.
//
// [Common data types]: https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-common.html
//
// This member is required.
Type *string
noSmithyDocumentSerde
}
// Information required to run the containerAction to produce dataset contents.
type ContainerDatasetAction struct {
// The ARN of the role that gives permission to the system to access required
// resources to run the containerAction . This includes, at minimum, permission to
// retrieve the dataset contents that are the input to the containerized
// application.
//
// This member is required.
ExecutionRoleArn *string
// The ARN of the Docker container stored in your account. The Docker container
// contains an application and required support libraries and is used to generate
// dataset contents.
//
// This member is required.
Image *string
// Configuration of the resource that executes the containerAction .
//
// This member is required.
ResourceConfiguration *ResourceConfiguration
// The values of variables used in the context of the execution of the
// containerized application (basically, parameters passed to the application).
// Each variable must have a name and a value given by one of stringValue ,
// datasetContentVersionValue , or outputFileUriValue .
Variables []Variable
noSmithyDocumentSerde
}
// Used to store channel data in an S3 bucket that you manage. If customer-managed
// storage is selected, the retentionPeriod parameter is ignored. You can't change
// the choice of S3 storage after the data store is created.
type CustomerManagedChannelS3Storage struct {
// The name of the S3 bucket in which channel data is stored.
//
// This member is required.
Bucket *string
// The ARN of the role that grants IoT Analytics permission to interact with your
// Amazon S3 resources.
//
// This member is required.
RoleArn *string
// (Optional) The prefix used to create the keys of the channel data objects. Each
// object in an S3 bucket has a key that is its unique identifier in the bucket.
// Each object in a bucket has exactly one key. The prefix must end with a forward
// slash (/).
KeyPrefix *string
noSmithyDocumentSerde
}
// Used to store channel data in an S3 bucket that you manage.
type CustomerManagedChannelS3StorageSummary struct {
// The name of the S3 bucket in which channel data is stored.
Bucket *string
// (Optional) The prefix used to create the keys of the channel data objects. Each
// object in an S3 bucket has a key that is its unique identifier within the bucket
// (each object in a bucket has exactly one key). The prefix must end with a
// forward slash (/).
KeyPrefix *string
// The ARN of the role that grants IoT Analytics permission to interact with your
// Amazon S3 resources.
RoleArn *string
noSmithyDocumentSerde
}
// S3-customer-managed; When you choose customer-managed storage, the
// retentionPeriod parameter is ignored. You can't change the choice of Amazon S3
// storage after your data store is created.
type CustomerManagedDatastoreS3Storage struct {
// The name of the Amazon S3 bucket where your data is stored.
//
// This member is required.
Bucket *string
// The ARN of the role that grants IoT Analytics permission to interact with your
// Amazon S3 resources.
//
// This member is required.
RoleArn *string
// (Optional) The prefix used to create the keys of the data store data objects.
// Each object in an Amazon S3 bucket has a key that is its unique identifier in
// the bucket. Each object in a bucket has exactly one key. The prefix must end
// with a forward slash (/).
KeyPrefix *string
noSmithyDocumentSerde
}
// Contains information about the data store that you manage.
type CustomerManagedDatastoreS3StorageSummary struct {
// The name of the Amazon S3 bucket where your data is stored.
Bucket *string
// (Optional) The prefix used to create the keys of the data store data objects.
// Each object in an Amazon S3 bucket has a key that is its unique identifier in
// the bucket. Each object in a bucket has exactly one key. The prefix must end
// with a forward slash (/).
KeyPrefix *string
// The ARN of the role that grants IoT Analytics permission to interact with your
// Amazon S3 resources.
RoleArn *string
noSmithyDocumentSerde
}
// Information about a dataset.
type Dataset struct {
// The DatasetAction objects that automatically create the dataset contents.
Actions []DatasetAction
// The ARN of the dataset.
Arn *string
// When dataset contents are created they are delivered to destinations specified
// here.
ContentDeliveryRules []DatasetContentDeliveryRule
// When the dataset was created.
CreationTime *time.Time
// The last time the dataset was updated.
LastUpdateTime *time.Time
// A list of data rules that send notifications to CloudWatch, when data arrives
// late. To specify lateDataRules , the dataset must use a [DeltaTimer] filter.
//
// [DeltaTimer]: https://docs.aws.amazon.com/iotanalytics/latest/APIReference/API_DeltaTime.html
LateDataRules []LateDataRule
// The name of the dataset.
Name *string
// Optional. How long, in days, message data is kept for the dataset.
RetentionPeriod *RetentionPeriod
// The status of the dataset.
Status DatasetStatus
// The DatasetTrigger objects that specify when the dataset is automatically
// updated.
Triggers []DatasetTrigger
// Optional. How many versions of dataset contents are kept. If not specified or
// set to null, only the latest version plus the latest succeeded version (if they
// are different) are kept for the time period specified by the retentionPeriod
// parameter. For more information, see [Keeping Multiple Versions of IoT Analytics datasets]in the IoT Analytics User Guide.
//
// [Keeping Multiple Versions of IoT Analytics datasets]: https://docs.aws.amazon.com/iotanalytics/latest/userguide/getting-started.html#aws-iot-analytics-dataset-versions
VersioningConfiguration *VersioningConfiguration
noSmithyDocumentSerde
}
// A DatasetAction object that specifies how dataset contents are automatically
// created.
type DatasetAction struct {
// The name of the dataset action by which dataset contents are automatically
// created.
ActionName *string
// Information that allows the system to run a containerized application to create
// the dataset contents. The application must be in a Docker container along with
// any required support libraries.
ContainerAction *ContainerDatasetAction
// An SqlQueryDatasetAction object that uses an SQL query to automatically create
// dataset contents.
QueryAction *SqlQueryDatasetAction
noSmithyDocumentSerde
}
// Information about the action that automatically creates the dataset's contents.
type DatasetActionSummary struct {
// The name of the action that automatically creates the dataset's contents.
ActionName *string
// The type of action by which the dataset's contents are automatically created.
ActionType DatasetActionType
noSmithyDocumentSerde
}
// The destination to which dataset contents are delivered.
type DatasetContentDeliveryDestination struct {
// Configuration information for delivery of dataset contents to IoT Events.
IotEventsDestinationConfiguration *IotEventsDestinationConfiguration
// Configuration information for delivery of dataset contents to Amazon S3.
S3DestinationConfiguration *S3DestinationConfiguration
noSmithyDocumentSerde
}
// When dataset contents are created, they are delivered to destination specified
// here.
type DatasetContentDeliveryRule struct {
// The destination to which dataset contents are delivered.
//
// This member is required.
Destination *DatasetContentDeliveryDestination
// The name of the dataset content delivery rules entry.
EntryName *string
noSmithyDocumentSerde
}
// The state of the dataset contents and the reason they are in this state.
type DatasetContentStatus struct {
// The reason the dataset contents are in this state.
Reason *string
// The state of the dataset contents. Can be one of READY, CREATING, SUCCEEDED, or
// FAILED.
State DatasetContentState
noSmithyDocumentSerde
}
// Summary information about dataset contents.
type DatasetContentSummary struct {
// The time the dataset content status was updated to SUCCEEDED or FAILED.
CompletionTime *time.Time
// The actual time the creation of the dataset contents was started.
CreationTime *time.Time
// The time the creation of the dataset contents was scheduled to start.
ScheduleTime *time.Time
// The status of the dataset contents.
Status *DatasetContentStatus
// The version of the dataset contents.
Version *string
noSmithyDocumentSerde
}
// The dataset whose latest contents are used as input to the notebook or
// application.
type DatasetContentVersionValue struct {
// The name of the dataset whose latest contents are used as input to the notebook
// or application.
//
// This member is required.
DatasetName *string
noSmithyDocumentSerde
}
// The reference to a dataset entry.
type DatasetEntry struct {
// The presigned URI of the dataset item.
DataURI *string
// The name of the dataset item.
EntryName *string
noSmithyDocumentSerde
}
// A summary of information about a dataset.
type DatasetSummary struct {
// A list of DataActionSummary objects.
Actions []DatasetActionSummary
// The time the dataset was created.
CreationTime *time.Time
// The name of the dataset.
DatasetName *string
// The last time the dataset was updated.
LastUpdateTime *time.Time
// The status of the dataset.
Status DatasetStatus
// A list of triggers. A trigger causes dataset content to be populated at a
// specified time interval or when another dataset is populated. The list of
// triggers can be empty or contain up to five DataSetTrigger objects
Triggers []DatasetTrigger
noSmithyDocumentSerde
}
// The DatasetTrigger that specifies when the dataset is automatically updated.
type DatasetTrigger struct {
// The dataset whose content creation triggers the creation of this dataset's
// contents.
Dataset *TriggeringDataset
// The Schedule when the trigger is initiated.
Schedule *Schedule
noSmithyDocumentSerde
}
// Information about a data store.
type Datastore struct {
// The ARN of the data store.
Arn *string
// When the data store was created.
CreationTime *time.Time
// Contains information about the partition dimensions in a data store.
DatastorePartitions *DatastorePartitions
// Contains the configuration information of file formats. IoT Analytics data
// stores support JSON and [Parquet].
//
// The default file format is JSON. You can specify only one format.
//
// You can't change the file format after you create the data store.
//
// [Parquet]: https://parquet.apache.org/
FileFormatConfiguration *FileFormatConfiguration
// The last time when a new message arrived in the data store.
//
// IoT Analytics updates this value at most once per minute for Amazon Simple
// Storage Service one data store. Hence, the lastMessageArrivalTime value is an
// approximation.
//
// This feature only applies to messages that arrived in the data store after
// October 23, 2020.
LastMessageArrivalTime *time.Time
// The last time the data store was updated.
LastUpdateTime *time.Time
// The name of the data store.
Name *string
// How long, in days, message data is kept for the data store. When
// customerManagedS3 storage is selected, this parameter is ignored.
RetentionPeriod *RetentionPeriod
// The status of a data store:
//
// CREATING The data store is being created.
//
// ACTIVE The data store has been created and can be used.
//
// DELETING The data store is being deleted.
Status DatastoreStatus
// Where data in a data store is stored.. You can choose serviceManagedS3 storage,
// customerManagedS3 storage, or iotSiteWiseMultiLayerStorage storage. The default
// is serviceManagedS3 . You can't change the choice of Amazon S3 storage after
// your data store is created.
Storage DatastoreStorage
noSmithyDocumentSerde
}
// The datastore activity that specifies where to store the processed data.
type DatastoreActivity struct {
// The name of the data store where processed messages are stored.
//
// This member is required.
DatastoreName *string
// The name of the datastore activity.
//
// This member is required.
Name *string
noSmithyDocumentSerde
}
// Used to store data used by IoT SiteWise in an Amazon S3 bucket that you
//
// manage. You can't change the choice of Amazon S3 storage after your data store
// is created.
type DatastoreIotSiteWiseMultiLayerStorage struct {
// Used to store data used by IoT SiteWise in an Amazon S3 bucket that you
// manage.
//
// This member is required.
CustomerManagedS3Storage *IotSiteWiseCustomerManagedDatastoreS3Storage
noSmithyDocumentSerde
}
// Contains information about the data store that you manage, which stores data
//
// used by IoT SiteWise.
type DatastoreIotSiteWiseMultiLayerStorageSummary struct {
// Used to store data used by IoT SiteWise in an Amazon S3 bucket that you manage.
CustomerManagedS3Storage *IotSiteWiseCustomerManagedDatastoreS3StorageSummary
noSmithyDocumentSerde
}
// A single dimension to partition a data store. The dimension must be an
//
// AttributePartition or a TimestampPartition .
type DatastorePartition struct {
// A partition dimension defined by an attributeName .
AttributePartition *Partition
// A partition dimension defined by a timestamp attribute.
TimestampPartition *TimestampPartition
noSmithyDocumentSerde
}
// Contains information about the partition dimensions in a data store.
type DatastorePartitions struct {
// A list of partition dimensions in a data store.
Partitions []DatastorePartition
noSmithyDocumentSerde
}
// Statistical information about the data store.
type DatastoreStatistics struct {
// The estimated size of the data store.
Size *EstimatedResourceSize
noSmithyDocumentSerde
}
// Where data in a data store is stored.. You can choose serviceManagedS3 storage,
// customerManagedS3 storage, or iotSiteWiseMultiLayerStorage storage. The default
// is serviceManagedS3 . You can't change the choice of Amazon S3 storage after
// your data store is created.
//
// The following types satisfy this interface:
//
// DatastoreStorageMemberCustomerManagedS3
// DatastoreStorageMemberIotSiteWiseMultiLayerStorage
// DatastoreStorageMemberServiceManagedS3
type DatastoreStorage interface {
isDatastoreStorage()
}
// S3-customer-managed; When you choose customer-managed storage, the
// retentionPeriod parameter is ignored. You can't change the choice of Amazon S3
// storage after your data store is created.
type DatastoreStorageMemberCustomerManagedS3 struct {
Value CustomerManagedDatastoreS3Storage
noSmithyDocumentSerde
}
func (*DatastoreStorageMemberCustomerManagedS3) isDatastoreStorage() {}
// Used to store data used by IoT SiteWise in an Amazon S3 bucket that you
//
// manage. You can't change the choice of Amazon S3 storage after your data store
// is created.
type DatastoreStorageMemberIotSiteWiseMultiLayerStorage struct {
Value DatastoreIotSiteWiseMultiLayerStorage
noSmithyDocumentSerde
}
func (*DatastoreStorageMemberIotSiteWiseMultiLayerStorage) isDatastoreStorage() {}
// Used to store data in an Amazon S3 bucket managed by IoT Analytics. You can't
// change the choice of Amazon S3 storage after your data store is created.
type DatastoreStorageMemberServiceManagedS3 struct {
Value ServiceManagedDatastoreS3Storage
noSmithyDocumentSerde
}
func (*DatastoreStorageMemberServiceManagedS3) isDatastoreStorage() {}
// Contains information about your data store.
type DatastoreStorageSummary struct {
// Used to store data in an Amazon S3 bucket managed by IoT Analytics.
CustomerManagedS3 *CustomerManagedDatastoreS3StorageSummary
// Used to store data used by IoT SiteWise in an Amazon S3 bucket that you
// manage.
IotSiteWiseMultiLayerStorage *DatastoreIotSiteWiseMultiLayerStorageSummary
// Used to store data in an Amazon S3 bucket managed by IoT Analytics.
ServiceManagedS3 *ServiceManagedDatastoreS3StorageSummary
noSmithyDocumentSerde
}
// A summary of information about a data store.
type DatastoreSummary struct {
// When the data store was created.
CreationTime *time.Time
// The name of the data store.
DatastoreName *string
// Contains information about the partition dimensions in a data store.
DatastorePartitions *DatastorePartitions
// Where data in a data store is stored.
DatastoreStorage *DatastoreStorageSummary
// The file format of the data in the data store.
FileFormatType FileFormatType
// The last time when a new message arrived in the data store.
//
// IoT Analytics updates this value at most once per minute for Amazon Simple
// Storage Service one data store. Hence, the lastMessageArrivalTime value is an
// approximation.
//
// This feature only applies to messages that arrived in the data store after
// October 23, 2020.
LastMessageArrivalTime *time.Time
// The last time the data store was updated.
LastUpdateTime *time.Time
// The status of the data store.
Status DatastoreStatus
noSmithyDocumentSerde
}
// Used to limit data to that which has arrived since the last execution of the
// action.
type DeltaTime struct {
// The number of seconds of estimated in-flight lag time of message data. When you
// create dataset contents using message data from a specified timeframe, some
// message data might still be in flight when processing begins, and so do not
// arrive in time to be processed. Use this field to make allowances for the in
// flight time of your message data, so that data not processed from a previous
// timeframe is included with the next timeframe. Otherwise, missed message data
// would be excluded from processing during the next timeframe too, because its
// timestamp places it within the previous timeframe.
//
// This member is required.
OffsetSeconds *int32
// An expression by which the time of the message data might be determined. This
// can be the name of a timestamp field or a SQL expression that is used to derive
// the time the message data was generated.
//
// This member is required.
TimeExpression *string
noSmithyDocumentSerde
}
// A structure that contains the configuration information of a delta time session
// window.
//
// [DeltaTime]DeltaTime specifies a time interval. You can use DeltaTime to create dataset
// contents with data that has arrived in the data store since the last execution.
// For an example of DeltaTime , see [Creating a SQL dataset with a delta window (CLI)] in the IoT Analytics User Guide.
//
// [DeltaTime]: https://docs.aws.amazon.com/iotanalytics/latest/APIReference/API_DeltaTime.html
// [Creating a SQL dataset with a delta window (CLI)]: https://docs.aws.amazon.com/iotanalytics/latest/userguide/automate-create-dataset.html#automate-example6
type DeltaTimeSessionWindowConfiguration struct {
// A time interval. You can use timeoutInMinutes so that IoT Analytics can batch
// up late data notifications that have been generated since the last execution.
// IoT Analytics sends one batch of notifications to Amazon CloudWatch Events at
// one time.
//
// For more information about how to write a timestamp expression, see [Date and Time Functions and Operators], in the
// Presto 0.172 Documentation.
//
// [Date and Time Functions and Operators]: https://prestodb.io/docs/0.172/functions/datetime.html
//
// This member is required.
TimeoutInMinutes *int32
noSmithyDocumentSerde
}
// An activity that adds data from the IoT device registry to your message.
type DeviceRegistryEnrichActivity struct {
// The name of the attribute that is added to the message.
//
// This member is required.
Attribute *string
// The name of the deviceRegistryEnrich activity.
//
// This member is required.
Name *string
// The ARN of the role that allows access to the device's registry information.
//
// This member is required.
RoleArn *string
// The name of the IoT device whose registry information is added to the message.
//
// This member is required.
ThingName *string
// The next activity in the pipeline.
Next *string
noSmithyDocumentSerde
}
// An activity that adds information from the IoT Device Shadow service to a
// message.
type DeviceShadowEnrichActivity struct {
// The name of the attribute that is added to the message.
//
// This member is required.
Attribute *string
// The name of the deviceShadowEnrich activity.
//
// This member is required.
Name *string
// The ARN of the role that allows access to the device's shadow.
//
// This member is required.
RoleArn *string
// The name of the IoT device whose shadow information is added to the message.
//
// This member is required.
ThingName *string
// The next activity in the pipeline.
Next *string
noSmithyDocumentSerde
}
// The estimated size of the resource.
type EstimatedResourceSize struct {
// The time when the estimate of the size of the resource was made.
EstimatedOn *time.Time
// The estimated size of the resource, in bytes.
EstimatedSizeInBytes *float64
noSmithyDocumentSerde
}
// Contains the configuration information of file formats. IoT Analytics data
// stores support JSON and [Parquet].
//
// The default file format is JSON. You can specify only one format.
//
// You can't change the file format after you create the data store.
//
// [Parquet]: https://parquet.apache.org/
type FileFormatConfiguration struct {
// Contains the configuration information of the JSON format.
JsonConfiguration *JsonConfiguration
// Contains the configuration information of the Parquet format.
ParquetConfiguration *ParquetConfiguration
noSmithyDocumentSerde
}
// An activity that filters a message based on its attributes.
type FilterActivity struct {
// An expression that looks like a SQL WHERE clause that must return a Boolean
// value. Messages that satisfy the condition are passed to the next activity.
//
// This member is required.
Filter *string
// The name of the filter activity.
//
// This member is required.
Name *string
// The next activity in the pipeline.
Next *string
noSmithyDocumentSerde
}
// Configuration information for coordination with Glue, a fully managed extract,
// transform and load (ETL) service.
type GlueConfiguration struct {
// The name of the database in your Glue Data Catalog in which the table is
// located. An Glue Data Catalog database contains metadata tables.
//
// This member is required.
DatabaseName *string
// The name of the table in your Glue Data Catalog that is used to perform the ETL
// operations. An Glue Data Catalog table contains partitioned data and
// descriptions of data sources and targets.
//
// This member is required.
TableName *string
noSmithyDocumentSerde
}
// Configuration information for delivery of dataset contents to IoT Events.
type IotEventsDestinationConfiguration struct {
// The name of the IoT Events input to which dataset contents are delivered.
//
// This member is required.
InputName *string
// The ARN of the role that grants IoT Analytics permission to deliver dataset
// contents to an IoT Events input.
//
// This member is required.
RoleArn *string
noSmithyDocumentSerde
}
// Used to store data used by IoT SiteWise in an Amazon S3 bucket that you
//
// manage. You can't change the choice of Amazon S3 storage after your data store
// is created.
type IotSiteWiseCustomerManagedDatastoreS3Storage struct {
// The name of the Amazon S3 bucket where your data is stored.
//
// This member is required.
Bucket *string
// (Optional) The prefix used to create the keys of the data store data objects.
// Each object in an Amazon S3 bucket has a key that is its unique identifier in
// the bucket. Each object in a bucket has exactly one key. The prefix must end
// with a forward slash (/).
KeyPrefix *string
noSmithyDocumentSerde
}
// Contains information about the data store that you manage, which stores data
//
// used by IoT SiteWise.
type IotSiteWiseCustomerManagedDatastoreS3StorageSummary struct {
// The name of the Amazon S3 bucket where your data is stored.
Bucket *string
// (Optional) The prefix used to create the keys of the data store data objects.
// Each object in an Amazon S3 bucket has a key that is its unique identifier in
// the bucket. Each object in a bucket has exactly one key. The prefix must end