aws-sdk-iotanalytics 1.34.0 → 1.39.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +208 -0
- data/LICENSE.txt +202 -0
- data/VERSION +1 -0
- data/lib/aws-sdk-iotanalytics.rb +2 -2
- data/lib/aws-sdk-iotanalytics/client.rb +259 -95
- data/lib/aws-sdk-iotanalytics/client_api.rb +93 -1
- data/lib/aws-sdk-iotanalytics/errors.rb +1 -1
- data/lib/aws-sdk-iotanalytics/resource.rb +1 -1
- data/lib/aws-sdk-iotanalytics/types.rb +927 -320
- metadata +11 -9
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
|
4
4
|
#
|
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
|
7
7
|
#
|
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
|
9
9
|
|
|
@@ -30,6 +30,7 @@ module Aws::IoTAnalytics
|
|
|
30
30
|
Channel = Shapes::StructureShape.new(name: 'Channel')
|
|
31
31
|
ChannelActivity = Shapes::StructureShape.new(name: 'ChannelActivity')
|
|
32
32
|
ChannelArn = Shapes::StringShape.new(name: 'ChannelArn')
|
|
33
|
+
ChannelMessages = Shapes::StructureShape.new(name: 'ChannelMessages')
|
|
33
34
|
ChannelName = Shapes::StringShape.new(name: 'ChannelName')
|
|
34
35
|
ChannelStatistics = Shapes::StructureShape.new(name: 'ChannelStatistics')
|
|
35
36
|
ChannelStatus = Shapes::StringShape.new(name: 'ChannelStatus')
|
|
@@ -37,6 +38,10 @@ module Aws::IoTAnalytics
|
|
|
37
38
|
ChannelStorageSummary = Shapes::StructureShape.new(name: 'ChannelStorageSummary')
|
|
38
39
|
ChannelSummaries = Shapes::ListShape.new(name: 'ChannelSummaries')
|
|
39
40
|
ChannelSummary = Shapes::StructureShape.new(name: 'ChannelSummary')
|
|
41
|
+
Column = Shapes::StructureShape.new(name: 'Column')
|
|
42
|
+
ColumnDataType = Shapes::StringShape.new(name: 'ColumnDataType')
|
|
43
|
+
ColumnName = Shapes::StringShape.new(name: 'ColumnName')
|
|
44
|
+
Columns = Shapes::ListShape.new(name: 'Columns')
|
|
40
45
|
ComputeType = Shapes::StringShape.new(name: 'ComputeType')
|
|
41
46
|
ContainerDatasetAction = Shapes::StructureShape.new(name: 'ContainerDatasetAction')
|
|
42
47
|
CreateChannelRequest = Shapes::StructureShape.new(name: 'CreateChannelRequest')
|
|
@@ -82,6 +87,8 @@ module Aws::IoTAnalytics
|
|
|
82
87
|
DatastoreActivity = Shapes::StructureShape.new(name: 'DatastoreActivity')
|
|
83
88
|
DatastoreArn = Shapes::StringShape.new(name: 'DatastoreArn')
|
|
84
89
|
DatastoreName = Shapes::StringShape.new(name: 'DatastoreName')
|
|
90
|
+
DatastorePartition = Shapes::StructureShape.new(name: 'DatastorePartition')
|
|
91
|
+
DatastorePartitions = Shapes::StructureShape.new(name: 'DatastorePartitions')
|
|
85
92
|
DatastoreStatistics = Shapes::StructureShape.new(name: 'DatastoreStatistics')
|
|
86
93
|
DatastoreStatus = Shapes::StringShape.new(name: 'DatastoreStatus')
|
|
87
94
|
DatastoreStorage = Shapes::StructureShape.new(name: 'DatastoreStorage')
|
|
@@ -94,6 +101,7 @@ module Aws::IoTAnalytics
|
|
|
94
101
|
DeleteDatastoreRequest = Shapes::StructureShape.new(name: 'DeleteDatastoreRequest')
|
|
95
102
|
DeletePipelineRequest = Shapes::StructureShape.new(name: 'DeletePipelineRequest')
|
|
96
103
|
DeltaTime = Shapes::StructureShape.new(name: 'DeltaTime')
|
|
104
|
+
DeltaTimeSessionWindowConfiguration = Shapes::StructureShape.new(name: 'DeltaTimeSessionWindowConfiguration')
|
|
97
105
|
DescribeChannelRequest = Shapes::StructureShape.new(name: 'DescribeChannelRequest')
|
|
98
106
|
DescribeChannelResponse = Shapes::StructureShape.new(name: 'DescribeChannelResponse')
|
|
99
107
|
DescribeDatasetRequest = Shapes::StructureShape.new(name: 'DescribeDatasetRequest')
|
|
@@ -112,6 +120,8 @@ module Aws::IoTAnalytics
|
|
|
112
120
|
ErrorCode = Shapes::StringShape.new(name: 'ErrorCode')
|
|
113
121
|
ErrorMessage = Shapes::StringShape.new(name: 'ErrorMessage')
|
|
114
122
|
EstimatedResourceSize = Shapes::StructureShape.new(name: 'EstimatedResourceSize')
|
|
123
|
+
FileFormatConfiguration = Shapes::StructureShape.new(name: 'FileFormatConfiguration')
|
|
124
|
+
FileFormatType = Shapes::StringShape.new(name: 'FileFormatType')
|
|
115
125
|
FilterActivity = Shapes::StructureShape.new(name: 'FilterActivity')
|
|
116
126
|
FilterExpression = Shapes::StringShape.new(name: 'FilterExpression')
|
|
117
127
|
GetDatasetContentRequest = Shapes::StructureShape.new(name: 'GetDatasetContentRequest')
|
|
@@ -125,8 +135,13 @@ module Aws::IoTAnalytics
|
|
|
125
135
|
InvalidRequestException = Shapes::StructureShape.new(name: 'InvalidRequestException')
|
|
126
136
|
IotEventsDestinationConfiguration = Shapes::StructureShape.new(name: 'IotEventsDestinationConfiguration')
|
|
127
137
|
IotEventsInputName = Shapes::StringShape.new(name: 'IotEventsInputName')
|
|
138
|
+
JsonConfiguration = Shapes::StructureShape.new(name: 'JsonConfiguration')
|
|
128
139
|
LambdaActivity = Shapes::StructureShape.new(name: 'LambdaActivity')
|
|
129
140
|
LambdaName = Shapes::StringShape.new(name: 'LambdaName')
|
|
141
|
+
LateDataRule = Shapes::StructureShape.new(name: 'LateDataRule')
|
|
142
|
+
LateDataRuleConfiguration = Shapes::StructureShape.new(name: 'LateDataRuleConfiguration')
|
|
143
|
+
LateDataRuleName = Shapes::StringShape.new(name: 'LateDataRuleName')
|
|
144
|
+
LateDataRules = Shapes::ListShape.new(name: 'LateDataRules')
|
|
130
145
|
LimitExceededException = Shapes::StructureShape.new(name: 'LimitExceededException')
|
|
131
146
|
ListChannelsRequest = Shapes::StructureShape.new(name: 'ListChannelsRequest')
|
|
132
147
|
ListChannelsResponse = Shapes::StructureShape.new(name: 'ListChannelsResponse')
|
|
@@ -158,6 +173,10 @@ module Aws::IoTAnalytics
|
|
|
158
173
|
OffsetSeconds = Shapes::IntegerShape.new(name: 'OffsetSeconds')
|
|
159
174
|
OutputFileName = Shapes::StringShape.new(name: 'OutputFileName')
|
|
160
175
|
OutputFileUriValue = Shapes::StructureShape.new(name: 'OutputFileUriValue')
|
|
176
|
+
ParquetConfiguration = Shapes::StructureShape.new(name: 'ParquetConfiguration')
|
|
177
|
+
Partition = Shapes::StructureShape.new(name: 'Partition')
|
|
178
|
+
PartitionAttributeName = Shapes::StringShape.new(name: 'PartitionAttributeName')
|
|
179
|
+
Partitions = Shapes::ListShape.new(name: 'Partitions')
|
|
161
180
|
Pipeline = Shapes::StructureShape.new(name: 'Pipeline')
|
|
162
181
|
PipelineActivities = Shapes::ListShape.new(name: 'PipelineActivities')
|
|
163
182
|
PipelineActivity = Shapes::StructureShape.new(name: 'PipelineActivity')
|
|
@@ -186,16 +205,20 @@ module Aws::IoTAnalytics
|
|
|
186
205
|
RunPipelineActivityResponse = Shapes::StructureShape.new(name: 'RunPipelineActivityResponse')
|
|
187
206
|
S3DestinationConfiguration = Shapes::StructureShape.new(name: 'S3DestinationConfiguration')
|
|
188
207
|
S3KeyPrefix = Shapes::StringShape.new(name: 'S3KeyPrefix')
|
|
208
|
+
S3PathChannelMessage = Shapes::StringShape.new(name: 'S3PathChannelMessage')
|
|
209
|
+
S3PathChannelMessages = Shapes::ListShape.new(name: 'S3PathChannelMessages')
|
|
189
210
|
SampleChannelDataRequest = Shapes::StructureShape.new(name: 'SampleChannelDataRequest')
|
|
190
211
|
SampleChannelDataResponse = Shapes::StructureShape.new(name: 'SampleChannelDataResponse')
|
|
191
212
|
Schedule = Shapes::StructureShape.new(name: 'Schedule')
|
|
192
213
|
ScheduleExpression = Shapes::StringShape.new(name: 'ScheduleExpression')
|
|
214
|
+
SchemaDefinition = Shapes::StructureShape.new(name: 'SchemaDefinition')
|
|
193
215
|
SelectAttributesActivity = Shapes::StructureShape.new(name: 'SelectAttributesActivity')
|
|
194
216
|
ServiceManagedChannelS3Storage = Shapes::StructureShape.new(name: 'ServiceManagedChannelS3Storage')
|
|
195
217
|
ServiceManagedChannelS3StorageSummary = Shapes::StructureShape.new(name: 'ServiceManagedChannelS3StorageSummary')
|
|
196
218
|
ServiceManagedDatastoreS3Storage = Shapes::StructureShape.new(name: 'ServiceManagedDatastoreS3Storage')
|
|
197
219
|
ServiceManagedDatastoreS3StorageSummary = Shapes::StructureShape.new(name: 'ServiceManagedDatastoreS3StorageSummary')
|
|
198
220
|
ServiceUnavailableException = Shapes::StructureShape.new(name: 'ServiceUnavailableException')
|
|
221
|
+
SessionTimeoutInMinutes = Shapes::IntegerShape.new(name: 'SessionTimeoutInMinutes')
|
|
199
222
|
SizeInBytes = Shapes::FloatShape.new(name: 'SizeInBytes')
|
|
200
223
|
SqlQuery = Shapes::StringShape.new(name: 'SqlQuery')
|
|
201
224
|
SqlQueryDatasetAction = Shapes::StructureShape.new(name: 'SqlQueryDatasetAction')
|
|
@@ -213,6 +236,8 @@ module Aws::IoTAnalytics
|
|
|
213
236
|
ThrottlingException = Shapes::StructureShape.new(name: 'ThrottlingException')
|
|
214
237
|
TimeExpression = Shapes::StringShape.new(name: 'TimeExpression')
|
|
215
238
|
Timestamp = Shapes::TimestampShape.new(name: 'Timestamp')
|
|
239
|
+
TimestampFormat = Shapes::StringShape.new(name: 'TimestampFormat')
|
|
240
|
+
TimestampPartition = Shapes::StructureShape.new(name: 'TimestampPartition')
|
|
216
241
|
TriggeringDataset = Shapes::StructureShape.new(name: 'TriggeringDataset')
|
|
217
242
|
UnlimitedRetentionPeriod = Shapes::BooleanShape.new(name: 'UnlimitedRetentionPeriod')
|
|
218
243
|
UnlimitedVersioning = Shapes::BooleanShape.new(name: 'UnlimitedVersioning')
|
|
@@ -268,6 +293,7 @@ module Aws::IoTAnalytics
|
|
|
268
293
|
Channel.add_member(:retention_period, Shapes::ShapeRef.new(shape: RetentionPeriod, location_name: "retentionPeriod"))
|
|
269
294
|
Channel.add_member(:creation_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "creationTime"))
|
|
270
295
|
Channel.add_member(:last_update_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "lastUpdateTime"))
|
|
296
|
+
Channel.add_member(:last_message_arrival_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "lastMessageArrivalTime"))
|
|
271
297
|
Channel.struct_class = Types::Channel
|
|
272
298
|
|
|
273
299
|
ChannelActivity.add_member(:name, Shapes::ShapeRef.new(shape: ActivityName, required: true, location_name: "name"))
|
|
@@ -275,6 +301,9 @@ module Aws::IoTAnalytics
|
|
|
275
301
|
ChannelActivity.add_member(:next, Shapes::ShapeRef.new(shape: ActivityName, location_name: "next"))
|
|
276
302
|
ChannelActivity.struct_class = Types::ChannelActivity
|
|
277
303
|
|
|
304
|
+
ChannelMessages.add_member(:s3_paths, Shapes::ShapeRef.new(shape: S3PathChannelMessages, location_name: "s3Paths"))
|
|
305
|
+
ChannelMessages.struct_class = Types::ChannelMessages
|
|
306
|
+
|
|
278
307
|
ChannelStatistics.add_member(:size, Shapes::ShapeRef.new(shape: EstimatedResourceSize, location_name: "size"))
|
|
279
308
|
ChannelStatistics.struct_class = Types::ChannelStatistics
|
|
280
309
|
|
|
@@ -293,8 +322,15 @@ module Aws::IoTAnalytics
|
|
|
293
322
|
ChannelSummary.add_member(:status, Shapes::ShapeRef.new(shape: ChannelStatus, location_name: "status"))
|
|
294
323
|
ChannelSummary.add_member(:creation_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "creationTime"))
|
|
295
324
|
ChannelSummary.add_member(:last_update_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "lastUpdateTime"))
|
|
325
|
+
ChannelSummary.add_member(:last_message_arrival_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "lastMessageArrivalTime"))
|
|
296
326
|
ChannelSummary.struct_class = Types::ChannelSummary
|
|
297
327
|
|
|
328
|
+
Column.add_member(:name, Shapes::ShapeRef.new(shape: ColumnName, required: true, location_name: "name"))
|
|
329
|
+
Column.add_member(:type, Shapes::ShapeRef.new(shape: ColumnDataType, required: true, location_name: "type"))
|
|
330
|
+
Column.struct_class = Types::Column
|
|
331
|
+
|
|
332
|
+
Columns.member = Shapes::ShapeRef.new(shape: Column)
|
|
333
|
+
|
|
298
334
|
ContainerDatasetAction.add_member(:image, Shapes::ShapeRef.new(shape: Image, required: true, location_name: "image"))
|
|
299
335
|
ContainerDatasetAction.add_member(:execution_role_arn, Shapes::ShapeRef.new(shape: RoleArn, required: true, location_name: "executionRoleArn"))
|
|
300
336
|
ContainerDatasetAction.add_member(:resource_configuration, Shapes::ShapeRef.new(shape: ResourceConfiguration, required: true, location_name: "resourceConfiguration"))
|
|
@@ -313,6 +349,7 @@ module Aws::IoTAnalytics
|
|
|
313
349
|
CreateChannelResponse.struct_class = Types::CreateChannelResponse
|
|
314
350
|
|
|
315
351
|
CreateDatasetContentRequest.add_member(:dataset_name, Shapes::ShapeRef.new(shape: DatasetName, required: true, location: "uri", location_name: "datasetName"))
|
|
352
|
+
CreateDatasetContentRequest.add_member(:version_id, Shapes::ShapeRef.new(shape: DatasetContentVersion, location_name: "versionId"))
|
|
316
353
|
CreateDatasetContentRequest.struct_class = Types::CreateDatasetContentRequest
|
|
317
354
|
|
|
318
355
|
CreateDatasetContentResponse.add_member(:version_id, Shapes::ShapeRef.new(shape: DatasetContentVersion, location_name: "versionId"))
|
|
@@ -325,6 +362,7 @@ module Aws::IoTAnalytics
|
|
|
325
362
|
CreateDatasetRequest.add_member(:retention_period, Shapes::ShapeRef.new(shape: RetentionPeriod, location_name: "retentionPeriod"))
|
|
326
363
|
CreateDatasetRequest.add_member(:versioning_configuration, Shapes::ShapeRef.new(shape: VersioningConfiguration, location_name: "versioningConfiguration"))
|
|
327
364
|
CreateDatasetRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "tags"))
|
|
365
|
+
CreateDatasetRequest.add_member(:late_data_rules, Shapes::ShapeRef.new(shape: LateDataRules, location_name: "lateDataRules"))
|
|
328
366
|
CreateDatasetRequest.struct_class = Types::CreateDatasetRequest
|
|
329
367
|
|
|
330
368
|
CreateDatasetResponse.add_member(:dataset_name, Shapes::ShapeRef.new(shape: DatasetName, location_name: "datasetName"))
|
|
@@ -336,6 +374,8 @@ module Aws::IoTAnalytics
|
|
|
336
374
|
CreateDatastoreRequest.add_member(:datastore_storage, Shapes::ShapeRef.new(shape: DatastoreStorage, location_name: "datastoreStorage"))
|
|
337
375
|
CreateDatastoreRequest.add_member(:retention_period, Shapes::ShapeRef.new(shape: RetentionPeriod, location_name: "retentionPeriod"))
|
|
338
376
|
CreateDatastoreRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "tags"))
|
|
377
|
+
CreateDatastoreRequest.add_member(:file_format_configuration, Shapes::ShapeRef.new(shape: FileFormatConfiguration, location_name: "fileFormatConfiguration"))
|
|
378
|
+
CreateDatastoreRequest.add_member(:datastore_partitions, Shapes::ShapeRef.new(shape: DatastorePartitions, location_name: "datastorePartitions"))
|
|
339
379
|
CreateDatastoreRequest.struct_class = Types::CreateDatastoreRequest
|
|
340
380
|
|
|
341
381
|
CreateDatastoreResponse.add_member(:datastore_name, Shapes::ShapeRef.new(shape: DatastoreName, location_name: "datastoreName"))
|
|
@@ -382,6 +422,7 @@ module Aws::IoTAnalytics
|
|
|
382
422
|
Dataset.add_member(:last_update_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "lastUpdateTime"))
|
|
383
423
|
Dataset.add_member(:retention_period, Shapes::ShapeRef.new(shape: RetentionPeriod, location_name: "retentionPeriod"))
|
|
384
424
|
Dataset.add_member(:versioning_configuration, Shapes::ShapeRef.new(shape: VersioningConfiguration, location_name: "versioningConfiguration"))
|
|
425
|
+
Dataset.add_member(:late_data_rules, Shapes::ShapeRef.new(shape: LateDataRules, location_name: "lateDataRules"))
|
|
385
426
|
Dataset.struct_class = Types::Dataset
|
|
386
427
|
|
|
387
428
|
DatasetAction.add_member(:action_name, Shapes::ShapeRef.new(shape: DatasetActionName, location_name: "actionName"))
|
|
@@ -452,12 +493,22 @@ module Aws::IoTAnalytics
|
|
|
452
493
|
Datastore.add_member(:retention_period, Shapes::ShapeRef.new(shape: RetentionPeriod, location_name: "retentionPeriod"))
|
|
453
494
|
Datastore.add_member(:creation_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "creationTime"))
|
|
454
495
|
Datastore.add_member(:last_update_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "lastUpdateTime"))
|
|
496
|
+
Datastore.add_member(:last_message_arrival_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "lastMessageArrivalTime"))
|
|
497
|
+
Datastore.add_member(:file_format_configuration, Shapes::ShapeRef.new(shape: FileFormatConfiguration, location_name: "fileFormatConfiguration"))
|
|
498
|
+
Datastore.add_member(:datastore_partitions, Shapes::ShapeRef.new(shape: DatastorePartitions, location_name: "datastorePartitions"))
|
|
455
499
|
Datastore.struct_class = Types::Datastore
|
|
456
500
|
|
|
457
501
|
DatastoreActivity.add_member(:name, Shapes::ShapeRef.new(shape: ActivityName, required: true, location_name: "name"))
|
|
458
502
|
DatastoreActivity.add_member(:datastore_name, Shapes::ShapeRef.new(shape: DatastoreName, required: true, location_name: "datastoreName"))
|
|
459
503
|
DatastoreActivity.struct_class = Types::DatastoreActivity
|
|
460
504
|
|
|
505
|
+
DatastorePartition.add_member(:attribute_partition, Shapes::ShapeRef.new(shape: Partition, location_name: "attributePartition"))
|
|
506
|
+
DatastorePartition.add_member(:timestamp_partition, Shapes::ShapeRef.new(shape: TimestampPartition, location_name: "timestampPartition"))
|
|
507
|
+
DatastorePartition.struct_class = Types::DatastorePartition
|
|
508
|
+
|
|
509
|
+
DatastorePartitions.add_member(:partitions, Shapes::ShapeRef.new(shape: Partitions, location_name: "partitions"))
|
|
510
|
+
DatastorePartitions.struct_class = Types::DatastorePartitions
|
|
511
|
+
|
|
461
512
|
DatastoreStatistics.add_member(:size, Shapes::ShapeRef.new(shape: EstimatedResourceSize, location_name: "size"))
|
|
462
513
|
DatastoreStatistics.struct_class = Types::DatastoreStatistics
|
|
463
514
|
|
|
@@ -476,6 +527,9 @@ module Aws::IoTAnalytics
|
|
|
476
527
|
DatastoreSummary.add_member(:status, Shapes::ShapeRef.new(shape: DatastoreStatus, location_name: "status"))
|
|
477
528
|
DatastoreSummary.add_member(:creation_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "creationTime"))
|
|
478
529
|
DatastoreSummary.add_member(:last_update_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "lastUpdateTime"))
|
|
530
|
+
DatastoreSummary.add_member(:last_message_arrival_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "lastMessageArrivalTime"))
|
|
531
|
+
DatastoreSummary.add_member(:file_format_type, Shapes::ShapeRef.new(shape: FileFormatType, location_name: "fileFormatType"))
|
|
532
|
+
DatastoreSummary.add_member(:datastore_partitions, Shapes::ShapeRef.new(shape: DatastorePartitions, location_name: "datastorePartitions"))
|
|
479
533
|
DatastoreSummary.struct_class = Types::DatastoreSummary
|
|
480
534
|
|
|
481
535
|
DeleteChannelRequest.add_member(:channel_name, Shapes::ShapeRef.new(shape: ChannelName, required: true, location: "uri", location_name: "channelName"))
|
|
@@ -498,6 +552,9 @@ module Aws::IoTAnalytics
|
|
|
498
552
|
DeltaTime.add_member(:time_expression, Shapes::ShapeRef.new(shape: TimeExpression, required: true, location_name: "timeExpression"))
|
|
499
553
|
DeltaTime.struct_class = Types::DeltaTime
|
|
500
554
|
|
|
555
|
+
DeltaTimeSessionWindowConfiguration.add_member(:timeout_in_minutes, Shapes::ShapeRef.new(shape: SessionTimeoutInMinutes, required: true, location_name: "timeoutInMinutes"))
|
|
556
|
+
DeltaTimeSessionWindowConfiguration.struct_class = Types::DeltaTimeSessionWindowConfiguration
|
|
557
|
+
|
|
501
558
|
DescribeChannelRequest.add_member(:channel_name, Shapes::ShapeRef.new(shape: ChannelName, required: true, location: "uri", location_name: "channelName"))
|
|
502
559
|
DescribeChannelRequest.add_member(:include_statistics, Shapes::ShapeRef.new(shape: IncludeStatisticsFlag, location: "querystring", location_name: "includeStatistics"))
|
|
503
560
|
DescribeChannelRequest.struct_class = Types::DescribeChannelRequest
|
|
@@ -549,6 +606,10 @@ module Aws::IoTAnalytics
|
|
|
549
606
|
EstimatedResourceSize.add_member(:estimated_on, Shapes::ShapeRef.new(shape: Timestamp, location_name: "estimatedOn"))
|
|
550
607
|
EstimatedResourceSize.struct_class = Types::EstimatedResourceSize
|
|
551
608
|
|
|
609
|
+
FileFormatConfiguration.add_member(:json_configuration, Shapes::ShapeRef.new(shape: JsonConfiguration, location_name: "jsonConfiguration"))
|
|
610
|
+
FileFormatConfiguration.add_member(:parquet_configuration, Shapes::ShapeRef.new(shape: ParquetConfiguration, location_name: "parquetConfiguration"))
|
|
611
|
+
FileFormatConfiguration.struct_class = Types::FileFormatConfiguration
|
|
612
|
+
|
|
552
613
|
FilterActivity.add_member(:name, Shapes::ShapeRef.new(shape: ActivityName, required: true, location_name: "name"))
|
|
553
614
|
FilterActivity.add_member(:filter, Shapes::ShapeRef.new(shape: FilterExpression, required: true, location_name: "filter"))
|
|
554
615
|
FilterActivity.add_member(:next, Shapes::ShapeRef.new(shape: ActivityName, location_name: "next"))
|
|
@@ -577,12 +638,23 @@ module Aws::IoTAnalytics
|
|
|
577
638
|
IotEventsDestinationConfiguration.add_member(:role_arn, Shapes::ShapeRef.new(shape: RoleArn, required: true, location_name: "roleArn"))
|
|
578
639
|
IotEventsDestinationConfiguration.struct_class = Types::IotEventsDestinationConfiguration
|
|
579
640
|
|
|
641
|
+
JsonConfiguration.struct_class = Types::JsonConfiguration
|
|
642
|
+
|
|
580
643
|
LambdaActivity.add_member(:name, Shapes::ShapeRef.new(shape: ActivityName, required: true, location_name: "name"))
|
|
581
644
|
LambdaActivity.add_member(:lambda_name, Shapes::ShapeRef.new(shape: LambdaName, required: true, location_name: "lambdaName"))
|
|
582
645
|
LambdaActivity.add_member(:batch_size, Shapes::ShapeRef.new(shape: ActivityBatchSize, required: true, location_name: "batchSize"))
|
|
583
646
|
LambdaActivity.add_member(:next, Shapes::ShapeRef.new(shape: ActivityName, location_name: "next"))
|
|
584
647
|
LambdaActivity.struct_class = Types::LambdaActivity
|
|
585
648
|
|
|
649
|
+
LateDataRule.add_member(:rule_name, Shapes::ShapeRef.new(shape: LateDataRuleName, location_name: "ruleName"))
|
|
650
|
+
LateDataRule.add_member(:rule_configuration, Shapes::ShapeRef.new(shape: LateDataRuleConfiguration, required: true, location_name: "ruleConfiguration"))
|
|
651
|
+
LateDataRule.struct_class = Types::LateDataRule
|
|
652
|
+
|
|
653
|
+
LateDataRuleConfiguration.add_member(:delta_time_session_window_configuration, Shapes::ShapeRef.new(shape: DeltaTimeSessionWindowConfiguration, location_name: "deltaTimeSessionWindowConfiguration"))
|
|
654
|
+
LateDataRuleConfiguration.struct_class = Types::LateDataRuleConfiguration
|
|
655
|
+
|
|
656
|
+
LateDataRules.member = Shapes::ShapeRef.new(shape: LateDataRule)
|
|
657
|
+
|
|
586
658
|
LimitExceededException.add_member(:message, Shapes::ShapeRef.new(shape: errorMessage, location_name: "message"))
|
|
587
659
|
LimitExceededException.struct_class = Types::LimitExceededException
|
|
588
660
|
|
|
@@ -657,6 +729,14 @@ module Aws::IoTAnalytics
|
|
|
657
729
|
OutputFileUriValue.add_member(:file_name, Shapes::ShapeRef.new(shape: OutputFileName, required: true, location_name: "fileName"))
|
|
658
730
|
OutputFileUriValue.struct_class = Types::OutputFileUriValue
|
|
659
731
|
|
|
732
|
+
ParquetConfiguration.add_member(:schema_definition, Shapes::ShapeRef.new(shape: SchemaDefinition, location_name: "schemaDefinition"))
|
|
733
|
+
ParquetConfiguration.struct_class = Types::ParquetConfiguration
|
|
734
|
+
|
|
735
|
+
Partition.add_member(:attribute_name, Shapes::ShapeRef.new(shape: PartitionAttributeName, required: true, location_name: "attributeName"))
|
|
736
|
+
Partition.struct_class = Types::Partition
|
|
737
|
+
|
|
738
|
+
Partitions.member = Shapes::ShapeRef.new(shape: DatastorePartition)
|
|
739
|
+
|
|
660
740
|
Pipeline.add_member(:name, Shapes::ShapeRef.new(shape: PipelineName, location_name: "name"))
|
|
661
741
|
Pipeline.add_member(:arn, Shapes::ShapeRef.new(shape: PipelineArn, location_name: "arn"))
|
|
662
742
|
Pipeline.add_member(:activities, Shapes::ShapeRef.new(shape: PipelineActivities, location_name: "activities"))
|
|
@@ -737,6 +817,8 @@ module Aws::IoTAnalytics
|
|
|
737
817
|
S3DestinationConfiguration.add_member(:role_arn, Shapes::ShapeRef.new(shape: RoleArn, required: true, location_name: "roleArn"))
|
|
738
818
|
S3DestinationConfiguration.struct_class = Types::S3DestinationConfiguration
|
|
739
819
|
|
|
820
|
+
S3PathChannelMessages.member = Shapes::ShapeRef.new(shape: S3PathChannelMessage)
|
|
821
|
+
|
|
740
822
|
SampleChannelDataRequest.add_member(:channel_name, Shapes::ShapeRef.new(shape: ChannelName, required: true, location: "uri", location_name: "channelName"))
|
|
741
823
|
SampleChannelDataRequest.add_member(:max_messages, Shapes::ShapeRef.new(shape: MaxMessages, location: "querystring", location_name: "maxMessages"))
|
|
742
824
|
SampleChannelDataRequest.add_member(:start_time, Shapes::ShapeRef.new(shape: StartTime, location: "querystring", location_name: "startTime"))
|
|
@@ -749,6 +831,9 @@ module Aws::IoTAnalytics
|
|
|
749
831
|
Schedule.add_member(:expression, Shapes::ShapeRef.new(shape: ScheduleExpression, location_name: "expression"))
|
|
750
832
|
Schedule.struct_class = Types::Schedule
|
|
751
833
|
|
|
834
|
+
SchemaDefinition.add_member(:columns, Shapes::ShapeRef.new(shape: Columns, location_name: "columns"))
|
|
835
|
+
SchemaDefinition.struct_class = Types::SchemaDefinition
|
|
836
|
+
|
|
752
837
|
SelectAttributesActivity.add_member(:name, Shapes::ShapeRef.new(shape: ActivityName, required: true, location_name: "name"))
|
|
753
838
|
SelectAttributesActivity.add_member(:attributes, Shapes::ShapeRef.new(shape: AttributeNames, required: true, location_name: "attributes"))
|
|
754
839
|
SelectAttributesActivity.add_member(:next, Shapes::ShapeRef.new(shape: ActivityName, location_name: "next"))
|
|
@@ -772,6 +857,7 @@ module Aws::IoTAnalytics
|
|
|
772
857
|
StartPipelineReprocessingRequest.add_member(:pipeline_name, Shapes::ShapeRef.new(shape: PipelineName, required: true, location: "uri", location_name: "pipelineName"))
|
|
773
858
|
StartPipelineReprocessingRequest.add_member(:start_time, Shapes::ShapeRef.new(shape: StartTime, location_name: "startTime"))
|
|
774
859
|
StartPipelineReprocessingRequest.add_member(:end_time, Shapes::ShapeRef.new(shape: EndTime, location_name: "endTime"))
|
|
860
|
+
StartPipelineReprocessingRequest.add_member(:channel_messages, Shapes::ShapeRef.new(shape: ChannelMessages, location_name: "channelMessages"))
|
|
775
861
|
StartPipelineReprocessingRequest.struct_class = Types::StartPipelineReprocessingRequest
|
|
776
862
|
|
|
777
863
|
StartPipelineReprocessingResponse.add_member(:reprocessing_id, Shapes::ShapeRef.new(shape: ReprocessingId, location_name: "reprocessingId"))
|
|
@@ -794,6 +880,10 @@ module Aws::IoTAnalytics
|
|
|
794
880
|
ThrottlingException.add_member(:message, Shapes::ShapeRef.new(shape: errorMessage, location_name: "message"))
|
|
795
881
|
ThrottlingException.struct_class = Types::ThrottlingException
|
|
796
882
|
|
|
883
|
+
TimestampPartition.add_member(:attribute_name, Shapes::ShapeRef.new(shape: PartitionAttributeName, required: true, location_name: "attributeName"))
|
|
884
|
+
TimestampPartition.add_member(:timestamp_format, Shapes::ShapeRef.new(shape: TimestampFormat, location_name: "timestampFormat"))
|
|
885
|
+
TimestampPartition.struct_class = Types::TimestampPartition
|
|
886
|
+
|
|
797
887
|
TriggeringDataset.add_member(:name, Shapes::ShapeRef.new(shape: DatasetName, required: true, location_name: "name"))
|
|
798
888
|
TriggeringDataset.struct_class = Types::TriggeringDataset
|
|
799
889
|
|
|
@@ -814,11 +904,13 @@ module Aws::IoTAnalytics
|
|
|
814
904
|
UpdateDatasetRequest.add_member(:content_delivery_rules, Shapes::ShapeRef.new(shape: DatasetContentDeliveryRules, location_name: "contentDeliveryRules"))
|
|
815
905
|
UpdateDatasetRequest.add_member(:retention_period, Shapes::ShapeRef.new(shape: RetentionPeriod, location_name: "retentionPeriod"))
|
|
816
906
|
UpdateDatasetRequest.add_member(:versioning_configuration, Shapes::ShapeRef.new(shape: VersioningConfiguration, location_name: "versioningConfiguration"))
|
|
907
|
+
UpdateDatasetRequest.add_member(:late_data_rules, Shapes::ShapeRef.new(shape: LateDataRules, location_name: "lateDataRules"))
|
|
817
908
|
UpdateDatasetRequest.struct_class = Types::UpdateDatasetRequest
|
|
818
909
|
|
|
819
910
|
UpdateDatastoreRequest.add_member(:datastore_name, Shapes::ShapeRef.new(shape: DatastoreName, required: true, location: "uri", location_name: "datastoreName"))
|
|
820
911
|
UpdateDatastoreRequest.add_member(:retention_period, Shapes::ShapeRef.new(shape: RetentionPeriod, location_name: "retentionPeriod"))
|
|
821
912
|
UpdateDatastoreRequest.add_member(:datastore_storage, Shapes::ShapeRef.new(shape: DatastoreStorage, location_name: "datastoreStorage"))
|
|
913
|
+
UpdateDatastoreRequest.add_member(:file_format_configuration, Shapes::ShapeRef.new(shape: FileFormatConfiguration, location_name: "fileFormatConfiguration"))
|
|
822
914
|
UpdateDatastoreRequest.struct_class = Types::UpdateDatastoreRequest
|
|
823
915
|
|
|
824
916
|
UpdatePipelineRequest.add_member(:pipeline_name, Shapes::ShapeRef.new(shape: PipelineName, required: true, location: "uri", location_name: "pipelineName"))
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
|
4
4
|
#
|
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
|
7
7
|
#
|
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
|
9
9
|
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
|
4
4
|
#
|
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
|
7
7
|
#
|
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
|
9
9
|
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
|
4
4
|
#
|
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
|
7
7
|
#
|
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
|
9
9
|
|
|
@@ -25,15 +25,15 @@ module Aws::IoTAnalytics
|
|
|
25
25
|
# }
|
|
26
26
|
#
|
|
27
27
|
# @!attribute [rw] name
|
|
28
|
-
# The name of the
|
|
28
|
+
# The name of the addAttributes activity.
|
|
29
29
|
# @return [String]
|
|
30
30
|
#
|
|
31
31
|
# @!attribute [rw] attributes
|
|
32
|
-
# A list of 1-50
|
|
32
|
+
# A list of 1-50 `AttributeNameMapping` objects that map an existing
|
|
33
33
|
# attribute to a new attribute.
|
|
34
34
|
#
|
|
35
35
|
# <note markdown="1"> The existing attributes remain in the message, so if you want to
|
|
36
|
-
# remove the originals, use
|
|
36
|
+
# remove the originals, use `RemoveAttributeActivity`.
|
|
37
37
|
#
|
|
38
38
|
# </note>
|
|
39
39
|
# @return [Hash<String,String>]
|
|
@@ -53,8 +53,8 @@ module Aws::IoTAnalytics
|
|
|
53
53
|
# Contains informations about errors.
|
|
54
54
|
#
|
|
55
55
|
# @!attribute [rw] message_id
|
|
56
|
-
# The ID of the message that caused the error.
|
|
57
|
-
# corresponding to the
|
|
56
|
+
# The ID of the message that caused the error. See the value
|
|
57
|
+
# corresponding to the `messageId` key in the message object.
|
|
58
58
|
# @return [String]
|
|
59
59
|
#
|
|
60
60
|
# @!attribute [rw] error_code
|
|
@@ -91,13 +91,13 @@ module Aws::IoTAnalytics
|
|
|
91
91
|
# @return [String]
|
|
92
92
|
#
|
|
93
93
|
# @!attribute [rw] messages
|
|
94
|
-
# The list of messages to be sent. Each message has format:
|
|
95
|
-
# "messageId": "string", "payload": "string"\\}
|
|
94
|
+
# The list of messages to be sent. Each message has the format: \\\{
|
|
95
|
+
# "messageId": "string", "payload": "string"\\}.
|
|
96
96
|
#
|
|
97
|
-
#
|
|
98
|
-
#
|
|
97
|
+
# The field names of message payloads (data) that you send to AWS IoT
|
|
98
|
+
# Analytics:
|
|
99
99
|
#
|
|
100
|
-
# * Must contain only alphanumeric characters and undescores (\_)
|
|
100
|
+
# * Must contain only alphanumeric characters and undescores (\_). No
|
|
101
101
|
# other special characters are allowed.
|
|
102
102
|
#
|
|
103
103
|
# * Must begin with an alphabetic character or single underscore (\_).
|
|
@@ -107,10 +107,10 @@ module Aws::IoTAnalytics
|
|
|
107
107
|
# * In regular expression terms:
|
|
108
108
|
# "^\[A-Za-z\_\](\[A-Za-z0-9\]*\|\[A-Za-z0-9\]\[A-Za-z0-9\_\]*)$".
|
|
109
109
|
#
|
|
110
|
-
# * Cannot be
|
|
110
|
+
# * Cannot be more than 255 characters.
|
|
111
111
|
#
|
|
112
|
-
# * Are case
|
|
113
|
-
#
|
|
112
|
+
# * Are case insensitive. (Fields named foo and FOO in the same
|
|
113
|
+
# payload are considered duplicates.)
|
|
114
114
|
#
|
|
115
115
|
# For example, \\\{"temp\_01": 29\\} or \\\{"\_temp\_01": 29\\}
|
|
116
116
|
# are valid, but \\\{"temp-01": 29\\}, \\\{"01\_temp": 29\\} or
|
|
@@ -149,7 +149,7 @@ module Aws::IoTAnalytics
|
|
|
149
149
|
#
|
|
150
150
|
# @!attribute [rw] reprocessing_id
|
|
151
151
|
# The ID of the reprocessing task (returned by
|
|
152
|
-
#
|
|
152
|
+
# `StartPipelineReprocessing`).
|
|
153
153
|
# @return [String]
|
|
154
154
|
#
|
|
155
155
|
class CancelPipelineReprocessingRequest < Struct.new(
|
|
@@ -169,10 +169,10 @@ module Aws::IoTAnalytics
|
|
|
169
169
|
# @return [String]
|
|
170
170
|
#
|
|
171
171
|
# @!attribute [rw] storage
|
|
172
|
-
# Where channel data is stored. You
|
|
173
|
-
#
|
|
174
|
-
#
|
|
175
|
-
#
|
|
172
|
+
# Where channel data is stored. You can choose one of
|
|
173
|
+
# `serviceManagedS3` or `customerManagedS3` storage. If not specified,
|
|
174
|
+
# the default is `serviceManagedS3`. You cannot change this storage
|
|
175
|
+
# option after the channel is created.
|
|
176
176
|
# @return [Types::ChannelStorage]
|
|
177
177
|
#
|
|
178
178
|
# @!attribute [rw] arn
|
|
@@ -195,6 +195,17 @@ module Aws::IoTAnalytics
|
|
|
195
195
|
# When the channel was last updated.
|
|
196
196
|
# @return [Time]
|
|
197
197
|
#
|
|
198
|
+
# @!attribute [rw] last_message_arrival_time
|
|
199
|
+
# The last time when a new message arrived in the channel.
|
|
200
|
+
#
|
|
201
|
+
# AWS IoT Analytics updates this value at most once per minute for one
|
|
202
|
+
# channel. Hence, the `lastMessageArrivalTime` value is an
|
|
203
|
+
# approximation.
|
|
204
|
+
#
|
|
205
|
+
# This feature only applies to messages that arrived in the data store
|
|
206
|
+
# after October 23, 2020.
|
|
207
|
+
# @return [Time]
|
|
208
|
+
#
|
|
198
209
|
class Channel < Struct.new(
|
|
199
210
|
:name,
|
|
200
211
|
:storage,
|
|
@@ -202,7 +213,8 @@ module Aws::IoTAnalytics
|
|
|
202
213
|
:status,
|
|
203
214
|
:retention_period,
|
|
204
215
|
:creation_time,
|
|
205
|
-
:last_update_time
|
|
216
|
+
:last_update_time,
|
|
217
|
+
:last_message_arrival_time)
|
|
206
218
|
SENSITIVE = []
|
|
207
219
|
include Aws::Structure
|
|
208
220
|
end
|
|
@@ -220,7 +232,7 @@ module Aws::IoTAnalytics
|
|
|
220
232
|
# }
|
|
221
233
|
#
|
|
222
234
|
# @!attribute [rw] name
|
|
223
|
-
# The name of the
|
|
235
|
+
# The name of the channel activity.
|
|
224
236
|
# @return [String]
|
|
225
237
|
#
|
|
226
238
|
# @!attribute [rw] channel_name
|
|
@@ -239,6 +251,31 @@ module Aws::IoTAnalytics
|
|
|
239
251
|
include Aws::Structure
|
|
240
252
|
end
|
|
241
253
|
|
|
254
|
+
# Specifies one or more sets of channel messages.
|
|
255
|
+
#
|
|
256
|
+
# @note When making an API call, you may pass ChannelMessages
|
|
257
|
+
# data as a hash:
|
|
258
|
+
#
|
|
259
|
+
# {
|
|
260
|
+
# s3_paths: ["S3PathChannelMessage"],
|
|
261
|
+
# }
|
|
262
|
+
#
|
|
263
|
+
# @!attribute [rw] s3_paths
|
|
264
|
+
# Specifies one or more keys that identify the Amazon Simple Storage
|
|
265
|
+
# Service (Amazon S3) objects that save your channel messages.
|
|
266
|
+
#
|
|
267
|
+
# You must use the full path for the key.
|
|
268
|
+
#
|
|
269
|
+
# Example path: `channel/mychannel/__dt=2020-02-29
|
|
270
|
+
# 00:00:00/1582940490000_1582940520000_123456789012_mychannel_0_2118.0.json.gz`
|
|
271
|
+
# @return [Array<String>]
|
|
272
|
+
#
|
|
273
|
+
class ChannelMessages < Struct.new(
|
|
274
|
+
:s3_paths)
|
|
275
|
+
SENSITIVE = []
|
|
276
|
+
include Aws::Structure
|
|
277
|
+
end
|
|
278
|
+
|
|
242
279
|
# Statistics information about the channel.
|
|
243
280
|
#
|
|
244
281
|
# @!attribute [rw] size
|
|
@@ -251,10 +288,10 @@ module Aws::IoTAnalytics
|
|
|
251
288
|
include Aws::Structure
|
|
252
289
|
end
|
|
253
290
|
|
|
254
|
-
# Where channel data is stored. You may choose one of
|
|
255
|
-
#
|
|
256
|
-
#
|
|
257
|
-
#
|
|
291
|
+
# Where channel data is stored. You may choose one of `serviceManagedS3`
|
|
292
|
+
# or `customerManagedS3` storage. If not specified, the default is
|
|
293
|
+
# `serviceManagedS3`. This cannot be changed after creation of the
|
|
294
|
+
# channel.
|
|
258
295
|
#
|
|
259
296
|
# @note When making an API call, you may pass ChannelStorage
|
|
260
297
|
# data as a hash:
|
|
@@ -270,18 +307,17 @@ module Aws::IoTAnalytics
|
|
|
270
307
|
# }
|
|
271
308
|
#
|
|
272
309
|
# @!attribute [rw] service_managed_s3
|
|
273
|
-
# Use this to store channel data in an S3 bucket managed by
|
|
274
|
-
#
|
|
275
|
-
# customer-managed S3 storage
|
|
276
|
-
# channel.
|
|
310
|
+
# Use this to store channel data in an S3 bucket managed by AWS IoT
|
|
311
|
+
# Analytics. You cannot change the choice of service-managed or
|
|
312
|
+
# customer-managed S3 storage after the channel is created.
|
|
277
313
|
# @return [Types::ServiceManagedChannelS3Storage]
|
|
278
314
|
#
|
|
279
315
|
# @!attribute [rw] customer_managed_s3
|
|
280
316
|
# Use this to store channel data in an S3 bucket that you manage. If
|
|
281
|
-
# customer managed storage is selected, the
|
|
282
|
-
# parameter is ignored.
|
|
283
|
-
# customer-managed S3 storage
|
|
284
|
-
#
|
|
317
|
+
# customer managed storage is selected, the `retentionPeriod`
|
|
318
|
+
# parameter is ignored. You cannot change the choice of
|
|
319
|
+
# service-managed or customer-managed S3 storage after the channel is
|
|
320
|
+
# created.
|
|
285
321
|
# @return [Types::CustomerManagedChannelS3Storage]
|
|
286
322
|
#
|
|
287
323
|
class ChannelStorage < Struct.new(
|
|
@@ -294,8 +330,8 @@ module Aws::IoTAnalytics
|
|
|
294
330
|
# Where channel data is stored.
|
|
295
331
|
#
|
|
296
332
|
# @!attribute [rw] service_managed_s3
|
|
297
|
-
# Used to store channel data in an S3 bucket managed by
|
|
298
|
-
# Analytics
|
|
333
|
+
# Used to store channel data in an S3 bucket managed by AWS IoT
|
|
334
|
+
# Analytics.
|
|
299
335
|
# @return [Types::ServiceManagedChannelS3StorageSummary]
|
|
300
336
|
#
|
|
301
337
|
# @!attribute [rw] customer_managed_s3
|
|
@@ -331,17 +367,59 @@ module Aws::IoTAnalytics
|
|
|
331
367
|
# The last time the channel was updated.
|
|
332
368
|
# @return [Time]
|
|
333
369
|
#
|
|
370
|
+
# @!attribute [rw] last_message_arrival_time
|
|
371
|
+
# The last time when a new message arrived in the channel.
|
|
372
|
+
#
|
|
373
|
+
# AWS IoT Analytics updates this value at most once per minute for one
|
|
374
|
+
# channel. Hence, the `lastMessageArrivalTime` value is an
|
|
375
|
+
# approximation.
|
|
376
|
+
#
|
|
377
|
+
# This feature only applies to messages that arrived in the data store
|
|
378
|
+
# after October 23, 2020.
|
|
379
|
+
# @return [Time]
|
|
380
|
+
#
|
|
334
381
|
class ChannelSummary < Struct.new(
|
|
335
382
|
:channel_name,
|
|
336
383
|
:channel_storage,
|
|
337
384
|
:status,
|
|
338
385
|
:creation_time,
|
|
339
|
-
:last_update_time
|
|
386
|
+
:last_update_time,
|
|
387
|
+
:last_message_arrival_time)
|
|
388
|
+
SENSITIVE = []
|
|
389
|
+
include Aws::Structure
|
|
390
|
+
end
|
|
391
|
+
|
|
392
|
+
# Contains information about a column that stores your data.
|
|
393
|
+
#
|
|
394
|
+
# @note When making an API call, you may pass Column
|
|
395
|
+
# data as a hash:
|
|
396
|
+
#
|
|
397
|
+
# {
|
|
398
|
+
# name: "ColumnName", # required
|
|
399
|
+
# type: "ColumnDataType", # required
|
|
400
|
+
# }
|
|
401
|
+
#
|
|
402
|
+
# @!attribute [rw] name
|
|
403
|
+
# The name of the column.
|
|
404
|
+
# @return [String]
|
|
405
|
+
#
|
|
406
|
+
# @!attribute [rw] type
|
|
407
|
+
# The type of data. For more information about the supported data
|
|
408
|
+
# types, see [Common data types][1] in the *AWS Glue Developer Guide*.
|
|
409
|
+
#
|
|
410
|
+
#
|
|
411
|
+
#
|
|
412
|
+
# [1]: https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-common.html
|
|
413
|
+
# @return [String]
|
|
414
|
+
#
|
|
415
|
+
class Column < Struct.new(
|
|
416
|
+
:name,
|
|
417
|
+
:type)
|
|
340
418
|
SENSITIVE = []
|
|
341
419
|
include Aws::Structure
|
|
342
420
|
end
|
|
343
421
|
|
|
344
|
-
# Information
|
|
422
|
+
# Information required to run the `containerAction` to produce dataset
|
|
345
423
|
# contents.
|
|
346
424
|
#
|
|
347
425
|
# @note When making an API call, you may pass ContainerDatasetAction
|
|
@@ -371,28 +449,27 @@ module Aws::IoTAnalytics
|
|
|
371
449
|
#
|
|
372
450
|
# @!attribute [rw] image
|
|
373
451
|
# The ARN of the Docker container stored in your account. The Docker
|
|
374
|
-
# container contains an application and
|
|
375
|
-
# is used to generate
|
|
452
|
+
# container contains an application and required support libraries and
|
|
453
|
+
# is used to generate dataset contents.
|
|
376
454
|
# @return [String]
|
|
377
455
|
#
|
|
378
456
|
# @!attribute [rw] execution_role_arn
|
|
379
|
-
# The ARN of the role
|
|
380
|
-
#
|
|
381
|
-
#
|
|
382
|
-
#
|
|
457
|
+
# The ARN of the role that gives permission to the system to access
|
|
458
|
+
# required resources to run the `containerAction`. This includes, at
|
|
459
|
+
# minimum, permission to retrieve the dataset contents that are the
|
|
460
|
+
# input to the containerized application.
|
|
383
461
|
# @return [String]
|
|
384
462
|
#
|
|
385
463
|
# @!attribute [rw] resource_configuration
|
|
386
|
-
# Configuration of the resource
|
|
387
|
-
# "containerAction".
|
|
464
|
+
# Configuration of the resource that executes the `containerAction`.
|
|
388
465
|
# @return [Types::ResourceConfiguration]
|
|
389
466
|
#
|
|
390
467
|
# @!attribute [rw] variables
|
|
391
|
-
# The values of variables used
|
|
392
|
-
#
|
|
468
|
+
# The values of variables used in the context of the execution of the
|
|
469
|
+
# containerized application (basically, parameters passed to the
|
|
393
470
|
# application). Each variable must have a name and a value given by
|
|
394
|
-
# one of
|
|
395
|
-
#
|
|
471
|
+
# one of `stringValue`, `datasetContentVersionValue`, or
|
|
472
|
+
# `outputFileUriValue`.
|
|
396
473
|
# @return [Array<Types::Variable>]
|
|
397
474
|
#
|
|
398
475
|
class ContainerDatasetAction < Struct.new(
|
|
@@ -435,16 +512,15 @@ module Aws::IoTAnalytics
|
|
|
435
512
|
# @return [String]
|
|
436
513
|
#
|
|
437
514
|
# @!attribute [rw] channel_storage
|
|
438
|
-
# Where channel data is stored. You
|
|
439
|
-
#
|
|
440
|
-
#
|
|
441
|
-
#
|
|
515
|
+
# Where channel data is stored. You can choose one of
|
|
516
|
+
# `serviceManagedS3` or `customerManagedS3` storage. If not specified,
|
|
517
|
+
# the default is `serviceManagedS3`. You cannot change this storage
|
|
518
|
+
# option after the channel is created.
|
|
442
519
|
# @return [Types::ChannelStorage]
|
|
443
520
|
#
|
|
444
521
|
# @!attribute [rw] retention_period
|
|
445
522
|
# How long, in days, message data is kept for the channel. When
|
|
446
|
-
#
|
|
447
|
-
# ignored.
|
|
523
|
+
# `customerManagedS3` storage is selected, this parameter is ignored.
|
|
448
524
|
# @return [Types::RetentionPeriod]
|
|
449
525
|
#
|
|
450
526
|
# @!attribute [rw] tags
|
|
@@ -485,20 +561,31 @@ module Aws::IoTAnalytics
|
|
|
485
561
|
#
|
|
486
562
|
# {
|
|
487
563
|
# dataset_name: "DatasetName", # required
|
|
564
|
+
# version_id: "DatasetContentVersion",
|
|
488
565
|
# }
|
|
489
566
|
#
|
|
490
567
|
# @!attribute [rw] dataset_name
|
|
491
|
-
# The name of the
|
|
568
|
+
# The name of the dataset.
|
|
569
|
+
# @return [String]
|
|
570
|
+
#
|
|
571
|
+
# @!attribute [rw] version_id
|
|
572
|
+
# The version ID of the dataset content. To specify `versionId` for a
|
|
573
|
+
# dataset content, the dataset must use a [DeltaTimer][1] filter.
|
|
574
|
+
#
|
|
575
|
+
#
|
|
576
|
+
#
|
|
577
|
+
# [1]: https://docs.aws.amazon.com/iotanalytics/latest/APIReference/API_DeltaTime.html
|
|
492
578
|
# @return [String]
|
|
493
579
|
#
|
|
494
580
|
class CreateDatasetContentRequest < Struct.new(
|
|
495
|
-
:dataset_name
|
|
581
|
+
:dataset_name,
|
|
582
|
+
:version_id)
|
|
496
583
|
SENSITIVE = []
|
|
497
584
|
include Aws::Structure
|
|
498
585
|
end
|
|
499
586
|
|
|
500
587
|
# @!attribute [rw] version_id
|
|
501
|
-
# The version ID of the
|
|
588
|
+
# The version ID of the dataset contents that are being created.
|
|
502
589
|
# @return [String]
|
|
503
590
|
#
|
|
504
591
|
class CreateDatasetContentResponse < Struct.new(
|
|
@@ -593,6 +680,16 @@ module Aws::IoTAnalytics
|
|
|
593
680
|
# value: "TagValue", # required
|
|
594
681
|
# },
|
|
595
682
|
# ],
|
|
683
|
+
# late_data_rules: [
|
|
684
|
+
# {
|
|
685
|
+
# rule_name: "LateDataRuleName",
|
|
686
|
+
# rule_configuration: { # required
|
|
687
|
+
# delta_time_session_window_configuration: {
|
|
688
|
+
# timeout_in_minutes: 1, # required
|
|
689
|
+
# },
|
|
690
|
+
# },
|
|
691
|
+
# },
|
|
692
|
+
# ],
|
|
596
693
|
# }
|
|
597
694
|
#
|
|
598
695
|
# @!attribute [rw] dataset_name
|
|
@@ -607,36 +704,55 @@ module Aws::IoTAnalytics
|
|
|
607
704
|
# A list of triggers. A trigger causes data set contents to be
|
|
608
705
|
# populated at a specified time interval or when another data set's
|
|
609
706
|
# contents are created. The list of triggers can be empty or contain
|
|
610
|
-
# up to five
|
|
707
|
+
# up to five `DataSetTrigger` objects.
|
|
611
708
|
# @return [Array<Types::DatasetTrigger>]
|
|
612
709
|
#
|
|
613
710
|
# @!attribute [rw] content_delivery_rules
|
|
614
|
-
# When
|
|
711
|
+
# When dataset contents are created, they are delivered to
|
|
615
712
|
# destinations specified here.
|
|
616
713
|
# @return [Array<Types::DatasetContentDeliveryRule>]
|
|
617
714
|
#
|
|
618
715
|
# @!attribute [rw] retention_period
|
|
619
|
-
#
|
|
620
|
-
#
|
|
621
|
-
#
|
|
622
|
-
# versions of
|
|
623
|
-
# `versioningConfiguration` parameter.
|
|
624
|
-
#
|
|
716
|
+
# Optional. How long, in days, versions of dataset contents are kept
|
|
717
|
+
# for the dataset. If not specified or set to `null`, versions of
|
|
718
|
+
# dataset contents are retained for at most 90 days. The number of
|
|
719
|
+
# versions of dataset contents retained is determined by the
|
|
720
|
+
# `versioningConfiguration` parameter. For more information, see
|
|
721
|
+
# [Keeping Multiple Versions of AWS IoT Analytics Data Sets][1] in the
|
|
722
|
+
# *AWS IoT Analytics User Guide*.
|
|
723
|
+
#
|
|
724
|
+
#
|
|
725
|
+
#
|
|
726
|
+
# [1]: https://docs.aws.amazon.com/iotanalytics/latest/userguide/getting-started.html#aws-iot-analytics-dataset-versions
|
|
625
727
|
# @return [Types::RetentionPeriod]
|
|
626
728
|
#
|
|
627
729
|
# @!attribute [rw] versioning_configuration
|
|
628
|
-
#
|
|
730
|
+
# Optional. How many versions of dataset contents are kept. If not
|
|
629
731
|
# specified or set to null, only the latest version plus the latest
|
|
630
732
|
# succeeded version (if they are different) are kept for the time
|
|
631
|
-
# period specified by the
|
|
632
|
-
# information, see
|
|
633
|
-
#
|
|
733
|
+
# period specified by the `retentionPeriod` parameter. For more
|
|
734
|
+
# information, see [Keeping Multiple Versions of AWS IoT Analytics
|
|
735
|
+
# Data Sets][1] in the *AWS IoT Analytics User Guide*.
|
|
736
|
+
#
|
|
737
|
+
#
|
|
738
|
+
#
|
|
739
|
+
# [1]: https://docs.aws.amazon.com/iotanalytics/latest/userguide/getting-started.html#aws-iot-analytics-dataset-versions
|
|
634
740
|
# @return [Types::VersioningConfiguration]
|
|
635
741
|
#
|
|
636
742
|
# @!attribute [rw] tags
|
|
637
743
|
# Metadata which can be used to manage the data set.
|
|
638
744
|
# @return [Array<Types::Tag>]
|
|
639
745
|
#
|
|
746
|
+
# @!attribute [rw] late_data_rules
|
|
747
|
+
# A list of data rules that send notifications to Amazon CloudWatch,
|
|
748
|
+
# when data arrives late. To specify `lateDataRules`, the dataset must
|
|
749
|
+
# use a [DeltaTimer][1] filter.
|
|
750
|
+
#
|
|
751
|
+
#
|
|
752
|
+
#
|
|
753
|
+
# [1]: https://docs.aws.amazon.com/iotanalytics/latest/APIReference/API_DeltaTime.html
|
|
754
|
+
# @return [Array<Types::LateDataRule>]
|
|
755
|
+
#
|
|
640
756
|
class CreateDatasetRequest < Struct.new(
|
|
641
757
|
:dataset_name,
|
|
642
758
|
:actions,
|
|
@@ -644,21 +760,22 @@ module Aws::IoTAnalytics
|
|
|
644
760
|
:content_delivery_rules,
|
|
645
761
|
:retention_period,
|
|
646
762
|
:versioning_configuration,
|
|
647
|
-
:tags
|
|
763
|
+
:tags,
|
|
764
|
+
:late_data_rules)
|
|
648
765
|
SENSITIVE = []
|
|
649
766
|
include Aws::Structure
|
|
650
767
|
end
|
|
651
768
|
|
|
652
769
|
# @!attribute [rw] dataset_name
|
|
653
|
-
# The name of the
|
|
770
|
+
# The name of the dataset.
|
|
654
771
|
# @return [String]
|
|
655
772
|
#
|
|
656
773
|
# @!attribute [rw] dataset_arn
|
|
657
|
-
# The ARN of the
|
|
774
|
+
# The ARN of the dataset.
|
|
658
775
|
# @return [String]
|
|
659
776
|
#
|
|
660
777
|
# @!attribute [rw] retention_period
|
|
661
|
-
# How long, in days,
|
|
778
|
+
# How long, in days, dataset contents are kept for the dataset.
|
|
662
779
|
# @return [Types::RetentionPeriod]
|
|
663
780
|
#
|
|
664
781
|
class CreateDatasetResponse < Struct.new(
|
|
@@ -693,6 +810,33 @@ module Aws::IoTAnalytics
|
|
|
693
810
|
# value: "TagValue", # required
|
|
694
811
|
# },
|
|
695
812
|
# ],
|
|
813
|
+
# file_format_configuration: {
|
|
814
|
+
# json_configuration: {
|
|
815
|
+
# },
|
|
816
|
+
# parquet_configuration: {
|
|
817
|
+
# schema_definition: {
|
|
818
|
+
# columns: [
|
|
819
|
+
# {
|
|
820
|
+
# name: "ColumnName", # required
|
|
821
|
+
# type: "ColumnDataType", # required
|
|
822
|
+
# },
|
|
823
|
+
# ],
|
|
824
|
+
# },
|
|
825
|
+
# },
|
|
826
|
+
# },
|
|
827
|
+
# datastore_partitions: {
|
|
828
|
+
# partitions: [
|
|
829
|
+
# {
|
|
830
|
+
# attribute_partition: {
|
|
831
|
+
# attribute_name: "PartitionAttributeName", # required
|
|
832
|
+
# },
|
|
833
|
+
# timestamp_partition: {
|
|
834
|
+
# attribute_name: "PartitionAttributeName", # required
|
|
835
|
+
# timestamp_format: "TimestampFormat",
|
|
836
|
+
# },
|
|
837
|
+
# },
|
|
838
|
+
# ],
|
|
839
|
+
# },
|
|
696
840
|
# }
|
|
697
841
|
#
|
|
698
842
|
# @!attribute [rw] datastore_name
|
|
@@ -700,27 +844,45 @@ module Aws::IoTAnalytics
|
|
|
700
844
|
# @return [String]
|
|
701
845
|
#
|
|
702
846
|
# @!attribute [rw] datastore_storage
|
|
703
|
-
# Where data store data is stored. You
|
|
704
|
-
#
|
|
705
|
-
#
|
|
706
|
-
#
|
|
847
|
+
# Where data store data is stored. You can choose one of
|
|
848
|
+
# `serviceManagedS3` or `customerManagedS3` storage. If not specified,
|
|
849
|
+
# the default is `serviceManagedS3`. You cannot change this storage
|
|
850
|
+
# option after the data store is created.
|
|
707
851
|
# @return [Types::DatastoreStorage]
|
|
708
852
|
#
|
|
709
853
|
# @!attribute [rw] retention_period
|
|
710
854
|
# How long, in days, message data is kept for the data store. When
|
|
711
|
-
#
|
|
712
|
-
# ignored.
|
|
855
|
+
# `customerManagedS3` storage is selected, this parameter is ignored.
|
|
713
856
|
# @return [Types::RetentionPeriod]
|
|
714
857
|
#
|
|
715
858
|
# @!attribute [rw] tags
|
|
716
859
|
# Metadata which can be used to manage the data store.
|
|
717
860
|
# @return [Array<Types::Tag>]
|
|
718
861
|
#
|
|
862
|
+
# @!attribute [rw] file_format_configuration
|
|
863
|
+
# Contains the configuration information of file formats. AWS IoT
|
|
864
|
+
# Analytics data stores support JSON and [Parquet][1].
|
|
865
|
+
#
|
|
866
|
+
# The default file format is JSON. You can specify only one format.
|
|
867
|
+
#
|
|
868
|
+
# You can't change the file format after you create the data store.
|
|
869
|
+
#
|
|
870
|
+
#
|
|
871
|
+
#
|
|
872
|
+
# [1]: https://parquet.apache.org/
|
|
873
|
+
# @return [Types::FileFormatConfiguration]
|
|
874
|
+
#
|
|
875
|
+
# @!attribute [rw] datastore_partitions
|
|
876
|
+
# Contains information about the partitions in a data store.
|
|
877
|
+
# @return [Types::DatastorePartitions]
|
|
878
|
+
#
|
|
719
879
|
class CreateDatastoreRequest < Struct.new(
|
|
720
880
|
:datastore_name,
|
|
721
881
|
:datastore_storage,
|
|
722
882
|
:retention_period,
|
|
723
|
-
:tags
|
|
883
|
+
:tags,
|
|
884
|
+
:file_format_configuration,
|
|
885
|
+
:datastore_partitions)
|
|
724
886
|
SENSITIVE = []
|
|
725
887
|
include Aws::Structure
|
|
726
888
|
end
|
|
@@ -824,16 +986,16 @@ module Aws::IoTAnalytics
|
|
|
824
986
|
# @return [String]
|
|
825
987
|
#
|
|
826
988
|
# @!attribute [rw] pipeline_activities
|
|
827
|
-
# A list of
|
|
989
|
+
# A list of `PipelineActivity` objects. Activities perform
|
|
828
990
|
# transformations on your messages, such as removing, renaming or
|
|
829
991
|
# adding message attributes; filtering messages based on attribute
|
|
830
992
|
# values; invoking your Lambda functions on messages for advanced
|
|
831
993
|
# processing; or performing mathematical transformations to normalize
|
|
832
994
|
# device data.
|
|
833
995
|
#
|
|
834
|
-
# The list can be 2-25
|
|
996
|
+
# The list can be 2-25 `PipelineActivity` objects and must contain
|
|
835
997
|
# both a `channel` and a `datastore` activity. Each entry in the list
|
|
836
|
-
# must contain only one activity
|
|
998
|
+
# must contain only one activity. For example:
|
|
837
999
|
#
|
|
838
1000
|
# `pipelineActivities = [ \{ "channel": \{ ... \} \}, \{ "lambda": \{
|
|
839
1001
|
# ... \} \}, ... ]`
|
|
@@ -867,10 +1029,9 @@ module Aws::IoTAnalytics
|
|
|
867
1029
|
end
|
|
868
1030
|
|
|
869
1031
|
# Use this to store channel data in an S3 bucket that you manage. If
|
|
870
|
-
# customer managed storage is selected, the
|
|
871
|
-
#
|
|
872
|
-
# customer-managed S3 storage
|
|
873
|
-
# channel.
|
|
1032
|
+
# customer managed storage is selected, the `retentionPeriod` parameter
|
|
1033
|
+
# is ignored. You cannot change the choice of service-managed or
|
|
1034
|
+
# customer-managed S3 storage after the channel is created.
|
|
874
1035
|
#
|
|
875
1036
|
# @note When making an API call, you may pass CustomerManagedChannelS3Storage
|
|
876
1037
|
# data as a hash:
|
|
@@ -882,18 +1043,18 @@ module Aws::IoTAnalytics
|
|
|
882
1043
|
# }
|
|
883
1044
|
#
|
|
884
1045
|
# @!attribute [rw] bucket
|
|
885
|
-
# The name of the
|
|
1046
|
+
# The name of the S3 bucket in which channel data is stored.
|
|
886
1047
|
# @return [String]
|
|
887
1048
|
#
|
|
888
1049
|
# @!attribute [rw] key_prefix
|
|
889
|
-
#
|
|
890
|
-
# objects. Each object in an
|
|
891
|
-
#
|
|
892
|
-
#
|
|
1050
|
+
# Optional. The prefix used to create the keys of the channel data
|
|
1051
|
+
# objects. Each object in an S3 bucket has a key that is its unique
|
|
1052
|
+
# identifier in the bucket. Each object in a bucket has exactly one
|
|
1053
|
+
# key. The prefix must end with a forward slash (/).
|
|
893
1054
|
# @return [String]
|
|
894
1055
|
#
|
|
895
1056
|
# @!attribute [rw] role_arn
|
|
896
|
-
# The ARN of the role
|
|
1057
|
+
# The ARN of the role that grants AWS IoT Analytics permission to
|
|
897
1058
|
# interact with your Amazon S3 resources.
|
|
898
1059
|
# @return [String]
|
|
899
1060
|
#
|
|
@@ -908,18 +1069,18 @@ module Aws::IoTAnalytics
|
|
|
908
1069
|
# Used to store channel data in an S3 bucket that you manage.
|
|
909
1070
|
#
|
|
910
1071
|
# @!attribute [rw] bucket
|
|
911
|
-
# The name of the
|
|
1072
|
+
# The name of the S3 bucket in which channel data is stored.
|
|
912
1073
|
# @return [String]
|
|
913
1074
|
#
|
|
914
1075
|
# @!attribute [rw] key_prefix
|
|
915
|
-
#
|
|
916
|
-
# objects. Each object in an
|
|
917
|
-
#
|
|
918
|
-
#
|
|
1076
|
+
# Optional. The prefix used to create the keys of the channel data
|
|
1077
|
+
# objects. Each object in an S3 bucket has a key that is its unique
|
|
1078
|
+
# identifier within the bucket (each object in a bucket has exactly
|
|
1079
|
+
# one key). The prefix must end with a forward slash (/).
|
|
919
1080
|
# @return [String]
|
|
920
1081
|
#
|
|
921
1082
|
# @!attribute [rw] role_arn
|
|
922
|
-
# The ARN of the role
|
|
1083
|
+
# The ARN of the role that grants AWS IoT Analytics permission to
|
|
923
1084
|
# interact with your Amazon S3 resources.
|
|
924
1085
|
# @return [String]
|
|
925
1086
|
#
|
|
@@ -932,10 +1093,9 @@ module Aws::IoTAnalytics
|
|
|
932
1093
|
end
|
|
933
1094
|
|
|
934
1095
|
# Use this to store data store data in an S3 bucket that you manage.
|
|
935
|
-
# When customer
|
|
936
|
-
# parameter is ignored.
|
|
937
|
-
# customer-managed S3 storage
|
|
938
|
-
# data store.
|
|
1096
|
+
# When customer-managed storage is selected, the `retentionPeriod`
|
|
1097
|
+
# parameter is ignored. You cannot change the choice of service-managed
|
|
1098
|
+
# or customer-managed S3 storage after the data store is created.
|
|
939
1099
|
#
|
|
940
1100
|
# @note When making an API call, you may pass CustomerManagedDatastoreS3Storage
|
|
941
1101
|
# data as a hash:
|
|
@@ -947,18 +1107,18 @@ module Aws::IoTAnalytics
|
|
|
947
1107
|
# }
|
|
948
1108
|
#
|
|
949
1109
|
# @!attribute [rw] bucket
|
|
950
|
-
# The name of the
|
|
1110
|
+
# The name of the S3 bucket in which data store data is stored.
|
|
951
1111
|
# @return [String]
|
|
952
1112
|
#
|
|
953
1113
|
# @!attribute [rw] key_prefix
|
|
954
|
-
#
|
|
955
|
-
#
|
|
956
|
-
#
|
|
957
|
-
#
|
|
1114
|
+
# Optional. The prefix used to create the keys of the data store data
|
|
1115
|
+
# objects. Each object in an S3 bucket has a key that is its unique
|
|
1116
|
+
# identifier in the bucket. Each object in a bucket has exactly one
|
|
1117
|
+
# key. The prefix must end with a forward slash (/).
|
|
958
1118
|
# @return [String]
|
|
959
1119
|
#
|
|
960
1120
|
# @!attribute [rw] role_arn
|
|
961
|
-
# The ARN of the role
|
|
1121
|
+
# The ARN of the role that grants AWS IoT Analytics permission to
|
|
962
1122
|
# interact with your Amazon S3 resources.
|
|
963
1123
|
# @return [String]
|
|
964
1124
|
#
|
|
@@ -973,18 +1133,18 @@ module Aws::IoTAnalytics
|
|
|
973
1133
|
# Used to store data store data in an S3 bucket that you manage.
|
|
974
1134
|
#
|
|
975
1135
|
# @!attribute [rw] bucket
|
|
976
|
-
# The name of the
|
|
1136
|
+
# The name of the S3 bucket in which data store data is stored.
|
|
977
1137
|
# @return [String]
|
|
978
1138
|
#
|
|
979
1139
|
# @!attribute [rw] key_prefix
|
|
980
|
-
#
|
|
981
|
-
#
|
|
982
|
-
#
|
|
983
|
-
#
|
|
1140
|
+
# Optional. The prefix used to create the keys of the data store data
|
|
1141
|
+
# objects. Each object in an S3 bucket has a key that is its unique
|
|
1142
|
+
# identifier in the bucket. Each object in a bucket has exactly one
|
|
1143
|
+
# key. The prefix must end with a forward slash (/).
|
|
984
1144
|
# @return [String]
|
|
985
1145
|
#
|
|
986
1146
|
# @!attribute [rw] role_arn
|
|
987
|
-
# The ARN of the role
|
|
1147
|
+
# The ARN of the role that grants AWS IoT Analytics permission to
|
|
988
1148
|
# interact with your Amazon S3 resources.
|
|
989
1149
|
# @return [String]
|
|
990
1150
|
#
|
|
@@ -1007,18 +1167,18 @@ module Aws::IoTAnalytics
|
|
|
1007
1167
|
# @return [String]
|
|
1008
1168
|
#
|
|
1009
1169
|
# @!attribute [rw] actions
|
|
1010
|
-
# The
|
|
1170
|
+
# The `DatasetAction` objects that automatically create the data set
|
|
1011
1171
|
# contents.
|
|
1012
1172
|
# @return [Array<Types::DatasetAction>]
|
|
1013
1173
|
#
|
|
1014
1174
|
# @!attribute [rw] triggers
|
|
1015
|
-
# The
|
|
1175
|
+
# The `DatasetTrigger` objects that specify when the data set is
|
|
1016
1176
|
# automatically updated.
|
|
1017
1177
|
# @return [Array<Types::DatasetTrigger>]
|
|
1018
1178
|
#
|
|
1019
1179
|
# @!attribute [rw] content_delivery_rules
|
|
1020
|
-
# When
|
|
1021
|
-
#
|
|
1180
|
+
# When dataset contents are created they are delivered to destinations
|
|
1181
|
+
# specified here.
|
|
1022
1182
|
# @return [Array<Types::DatasetContentDeliveryRule>]
|
|
1023
1183
|
#
|
|
1024
1184
|
# @!attribute [rw] status
|
|
@@ -1034,19 +1194,32 @@ module Aws::IoTAnalytics
|
|
|
1034
1194
|
# @return [Time]
|
|
1035
1195
|
#
|
|
1036
1196
|
# @!attribute [rw] retention_period
|
|
1037
|
-
#
|
|
1038
|
-
# set.
|
|
1197
|
+
# Optional. How long, in days, message data is kept for the data set.
|
|
1039
1198
|
# @return [Types::RetentionPeriod]
|
|
1040
1199
|
#
|
|
1041
1200
|
# @!attribute [rw] versioning_configuration
|
|
1042
|
-
#
|
|
1201
|
+
# Optional. How many versions of dataset contents are kept. If not
|
|
1043
1202
|
# specified or set to null, only the latest version plus the latest
|
|
1044
1203
|
# succeeded version (if they are different) are kept for the time
|
|
1045
|
-
# period specified by the
|
|
1046
|
-
# information, see
|
|
1047
|
-
#
|
|
1204
|
+
# period specified by the `retentionPeriod` parameter. For more
|
|
1205
|
+
# information, see [Keeping Multiple Versions of AWS IoT Analytics
|
|
1206
|
+
# Data Sets][1] in the *AWS IoT Analytics User Guide*.
|
|
1207
|
+
#
|
|
1208
|
+
#
|
|
1209
|
+
#
|
|
1210
|
+
# [1]: https://docs.aws.amazon.com/iotanalytics/latest/userguide/getting-started.html#aws-iot-analytics-dataset-versions
|
|
1048
1211
|
# @return [Types::VersioningConfiguration]
|
|
1049
1212
|
#
|
|
1213
|
+
# @!attribute [rw] late_data_rules
|
|
1214
|
+
# A list of data rules that send notifications to Amazon CloudWatch,
|
|
1215
|
+
# when data arrives late. To specify `lateDataRules`, the dataset must
|
|
1216
|
+
# use a [DeltaTimer][1] filter.
|
|
1217
|
+
#
|
|
1218
|
+
#
|
|
1219
|
+
#
|
|
1220
|
+
# [1]: https://docs.aws.amazon.com/iotanalytics/latest/APIReference/API_DeltaTime.html
|
|
1221
|
+
# @return [Array<Types::LateDataRule>]
|
|
1222
|
+
#
|
|
1050
1223
|
class Dataset < Struct.new(
|
|
1051
1224
|
:name,
|
|
1052
1225
|
:arn,
|
|
@@ -1057,12 +1230,13 @@ module Aws::IoTAnalytics
|
|
|
1057
1230
|
:creation_time,
|
|
1058
1231
|
:last_update_time,
|
|
1059
1232
|
:retention_period,
|
|
1060
|
-
:versioning_configuration
|
|
1233
|
+
:versioning_configuration,
|
|
1234
|
+
:late_data_rules)
|
|
1061
1235
|
SENSITIVE = []
|
|
1062
1236
|
include Aws::Structure
|
|
1063
1237
|
end
|
|
1064
1238
|
|
|
1065
|
-
# A
|
|
1239
|
+
# A `DatasetAction` object that specifies how data set contents are
|
|
1066
1240
|
# automatically created.
|
|
1067
1241
|
#
|
|
1068
1242
|
# @note When making an API call, you may pass DatasetAction
|
|
@@ -1110,15 +1284,14 @@ module Aws::IoTAnalytics
|
|
|
1110
1284
|
# @return [String]
|
|
1111
1285
|
#
|
|
1112
1286
|
# @!attribute [rw] query_action
|
|
1113
|
-
# An
|
|
1287
|
+
# An `SqlQueryDatasetAction` object that uses an SQL query to
|
|
1114
1288
|
# automatically create data set contents.
|
|
1115
1289
|
# @return [Types::SqlQueryDatasetAction]
|
|
1116
1290
|
#
|
|
1117
1291
|
# @!attribute [rw] container_action
|
|
1118
|
-
# Information
|
|
1119
|
-
# application
|
|
1120
|
-
#
|
|
1121
|
-
# support libraries.
|
|
1292
|
+
# Information that allows the system to run a containerized
|
|
1293
|
+
# application to create the dataset contents. The application must be
|
|
1294
|
+
# in a Docker container along with any required support libraries.
|
|
1122
1295
|
# @return [Types::ContainerDatasetAction]
|
|
1123
1296
|
#
|
|
1124
1297
|
class DatasetAction < Struct.new(
|
|
@@ -1129,16 +1302,16 @@ module Aws::IoTAnalytics
|
|
|
1129
1302
|
include Aws::Structure
|
|
1130
1303
|
end
|
|
1131
1304
|
|
|
1132
|
-
# Information about the action
|
|
1133
|
-
#
|
|
1305
|
+
# Information about the action that automatically creates the dataset's
|
|
1306
|
+
# contents.
|
|
1134
1307
|
#
|
|
1135
1308
|
# @!attribute [rw] action_name
|
|
1136
|
-
# The name of the action
|
|
1309
|
+
# The name of the action that automatically creates the dataset's
|
|
1137
1310
|
# contents.
|
|
1138
1311
|
# @return [String]
|
|
1139
1312
|
#
|
|
1140
1313
|
# @!attribute [rw] action_type
|
|
1141
|
-
# The type of action by which the
|
|
1314
|
+
# The type of action by which the dataset's contents are
|
|
1142
1315
|
# automatically created.
|
|
1143
1316
|
# @return [String]
|
|
1144
1317
|
#
|
|
@@ -1149,7 +1322,7 @@ module Aws::IoTAnalytics
|
|
|
1149
1322
|
include Aws::Structure
|
|
1150
1323
|
end
|
|
1151
1324
|
|
|
1152
|
-
# The destination to which
|
|
1325
|
+
# The destination to which dataset contents are delivered.
|
|
1153
1326
|
#
|
|
1154
1327
|
# @note When making an API call, you may pass DatasetContentDeliveryDestination
|
|
1155
1328
|
# data as a hash:
|
|
@@ -1171,13 +1344,13 @@ module Aws::IoTAnalytics
|
|
|
1171
1344
|
# }
|
|
1172
1345
|
#
|
|
1173
1346
|
# @!attribute [rw] iot_events_destination_configuration
|
|
1174
|
-
# Configuration information for delivery of
|
|
1347
|
+
# Configuration information for delivery of dataset contents to AWS
|
|
1175
1348
|
# IoT Events.
|
|
1176
1349
|
# @return [Types::IotEventsDestinationConfiguration]
|
|
1177
1350
|
#
|
|
1178
1351
|
# @!attribute [rw] s3_destination_configuration
|
|
1179
|
-
# Configuration information for delivery of
|
|
1180
|
-
#
|
|
1352
|
+
# Configuration information for delivery of dataset contents to Amazon
|
|
1353
|
+
# S3.
|
|
1181
1354
|
# @return [Types::S3DestinationConfiguration]
|
|
1182
1355
|
#
|
|
1183
1356
|
class DatasetContentDeliveryDestination < Struct.new(
|
|
@@ -1187,7 +1360,7 @@ module Aws::IoTAnalytics
|
|
|
1187
1360
|
include Aws::Structure
|
|
1188
1361
|
end
|
|
1189
1362
|
|
|
1190
|
-
# When
|
|
1363
|
+
# When dataset contents are created, they are delivered to destination
|
|
1191
1364
|
# specified here.
|
|
1192
1365
|
#
|
|
1193
1366
|
# @note When making an API call, you may pass DatasetContentDeliveryRule
|
|
@@ -1213,11 +1386,11 @@ module Aws::IoTAnalytics
|
|
|
1213
1386
|
# }
|
|
1214
1387
|
#
|
|
1215
1388
|
# @!attribute [rw] entry_name
|
|
1216
|
-
# The name of the
|
|
1389
|
+
# The name of the dataset content delivery rules entry.
|
|
1217
1390
|
# @return [String]
|
|
1218
1391
|
#
|
|
1219
1392
|
# @!attribute [rw] destination
|
|
1220
|
-
# The destination to which
|
|
1393
|
+
# The destination to which dataset contents are delivered.
|
|
1221
1394
|
# @return [Types::DatasetContentDeliveryDestination]
|
|
1222
1395
|
#
|
|
1223
1396
|
class DatasetContentDeliveryRule < Struct.new(
|
|
@@ -1231,8 +1404,8 @@ module Aws::IoTAnalytics
|
|
|
1231
1404
|
# state.
|
|
1232
1405
|
#
|
|
1233
1406
|
# @!attribute [rw] state
|
|
1234
|
-
# The state of the data set contents. Can be one of
|
|
1235
|
-
#
|
|
1407
|
+
# The state of the data set contents. Can be one of READY, CREATING,
|
|
1408
|
+
# SUCCEEDED, or FAILED.
|
|
1236
1409
|
# @return [String]
|
|
1237
1410
|
#
|
|
1238
1411
|
# @!attribute [rw] reason
|
|
@@ -1246,10 +1419,10 @@ module Aws::IoTAnalytics
|
|
|
1246
1419
|
include Aws::Structure
|
|
1247
1420
|
end
|
|
1248
1421
|
|
|
1249
|
-
# Summary information about
|
|
1422
|
+
# Summary information about dataset contents.
|
|
1250
1423
|
#
|
|
1251
1424
|
# @!attribute [rw] version
|
|
1252
|
-
# The version of the
|
|
1425
|
+
# The version of the dataset contents.
|
|
1253
1426
|
# @return [String]
|
|
1254
1427
|
#
|
|
1255
1428
|
# @!attribute [rw] status
|
|
@@ -1257,11 +1430,11 @@ module Aws::IoTAnalytics
|
|
|
1257
1430
|
# @return [Types::DatasetContentStatus]
|
|
1258
1431
|
#
|
|
1259
1432
|
# @!attribute [rw] creation_time
|
|
1260
|
-
# The actual time the creation of the
|
|
1433
|
+
# The actual time the creation of the dataset contents was started.
|
|
1261
1434
|
# @return [Time]
|
|
1262
1435
|
#
|
|
1263
1436
|
# @!attribute [rw] schedule_time
|
|
1264
|
-
# The time the creation of the
|
|
1437
|
+
# The time the creation of the dataset contents was scheduled to
|
|
1265
1438
|
# start.
|
|
1266
1439
|
# @return [Time]
|
|
1267
1440
|
#
|
|
@@ -1280,8 +1453,8 @@ module Aws::IoTAnalytics
|
|
|
1280
1453
|
include Aws::Structure
|
|
1281
1454
|
end
|
|
1282
1455
|
|
|
1283
|
-
# The
|
|
1284
|
-
#
|
|
1456
|
+
# The dataset whose latest contents are used as input to the notebook or
|
|
1457
|
+
# application.
|
|
1285
1458
|
#
|
|
1286
1459
|
# @note When making an API call, you may pass DatasetContentVersionValue
|
|
1287
1460
|
# data as a hash:
|
|
@@ -1291,7 +1464,7 @@ module Aws::IoTAnalytics
|
|
|
1291
1464
|
# }
|
|
1292
1465
|
#
|
|
1293
1466
|
# @!attribute [rw] dataset_name
|
|
1294
|
-
# The name of the
|
|
1467
|
+
# The name of the dataset whose latest contents are used as input to
|
|
1295
1468
|
# the notebook or application.
|
|
1296
1469
|
# @return [String]
|
|
1297
1470
|
#
|
|
@@ -1308,7 +1481,7 @@ module Aws::IoTAnalytics
|
|
|
1308
1481
|
# @return [String]
|
|
1309
1482
|
#
|
|
1310
1483
|
# @!attribute [rw] data_uri
|
|
1311
|
-
# The
|
|
1484
|
+
# The presigned URI of the data set item.
|
|
1312
1485
|
# @return [String]
|
|
1313
1486
|
#
|
|
1314
1487
|
class DatasetEntry < Struct.new(
|
|
@@ -1340,11 +1513,11 @@ module Aws::IoTAnalytics
|
|
|
1340
1513
|
# A list of triggers. A trigger causes data set content to be
|
|
1341
1514
|
# populated at a specified time interval or when another data set is
|
|
1342
1515
|
# populated. The list of triggers can be empty or contain up to five
|
|
1343
|
-
# DataSetTrigger objects
|
|
1516
|
+
# `DataSetTrigger` objects
|
|
1344
1517
|
# @return [Array<Types::DatasetTrigger>]
|
|
1345
1518
|
#
|
|
1346
1519
|
# @!attribute [rw] actions
|
|
1347
|
-
# A list of
|
|
1520
|
+
# A list of `DataActionSummary` objects.
|
|
1348
1521
|
# @return [Array<Types::DatasetActionSummary>]
|
|
1349
1522
|
#
|
|
1350
1523
|
class DatasetSummary < Struct.new(
|
|
@@ -1358,8 +1531,8 @@ module Aws::IoTAnalytics
|
|
|
1358
1531
|
include Aws::Structure
|
|
1359
1532
|
end
|
|
1360
1533
|
|
|
1361
|
-
# The
|
|
1362
|
-
#
|
|
1534
|
+
# The `DatasetTrigger` that specifies when the data set is automatically
|
|
1535
|
+
# updated.
|
|
1363
1536
|
#
|
|
1364
1537
|
# @note When making an API call, you may pass DatasetTrigger
|
|
1365
1538
|
# data as a hash:
|
|
@@ -1374,7 +1547,7 @@ module Aws::IoTAnalytics
|
|
|
1374
1547
|
# }
|
|
1375
1548
|
#
|
|
1376
1549
|
# @!attribute [rw] schedule
|
|
1377
|
-
# The
|
|
1550
|
+
# The Schedule when the trigger is initiated.
|
|
1378
1551
|
# @return [Types::Schedule]
|
|
1379
1552
|
#
|
|
1380
1553
|
# @!attribute [rw] dataset
|
|
@@ -1396,10 +1569,10 @@ module Aws::IoTAnalytics
|
|
|
1396
1569
|
# @return [String]
|
|
1397
1570
|
#
|
|
1398
1571
|
# @!attribute [rw] storage
|
|
1399
|
-
# Where data store data is stored. You
|
|
1400
|
-
#
|
|
1401
|
-
#
|
|
1402
|
-
#
|
|
1572
|
+
# Where data store data is stored. You can choose one of
|
|
1573
|
+
# `serviceManagedS3` or `customerManagedS3` storage. If not specified,
|
|
1574
|
+
# the default is `serviceManagedS3`. You cannot change this storage
|
|
1575
|
+
# option after the data store is created.
|
|
1403
1576
|
# @return [Types::DatastoreStorage]
|
|
1404
1577
|
#
|
|
1405
1578
|
# @!attribute [rw] arn
|
|
@@ -1424,8 +1597,7 @@ module Aws::IoTAnalytics
|
|
|
1424
1597
|
#
|
|
1425
1598
|
# @!attribute [rw] retention_period
|
|
1426
1599
|
# How long, in days, message data is kept for the data store. When
|
|
1427
|
-
#
|
|
1428
|
-
# ignored.
|
|
1600
|
+
# `customerManagedS3` storage is selected, this parameter is ignored.
|
|
1429
1601
|
# @return [Types::RetentionPeriod]
|
|
1430
1602
|
#
|
|
1431
1603
|
# @!attribute [rw] creation_time
|
|
@@ -1436,6 +1608,34 @@ module Aws::IoTAnalytics
|
|
|
1436
1608
|
# The last time the data store was updated.
|
|
1437
1609
|
# @return [Time]
|
|
1438
1610
|
#
|
|
1611
|
+
# @!attribute [rw] last_message_arrival_time
|
|
1612
|
+
# The last time when a new message arrived in the data store.
|
|
1613
|
+
#
|
|
1614
|
+
# AWS IoT Analytics updates this value at most once per minute for one
|
|
1615
|
+
# data store. Hence, the `lastMessageArrivalTime` value is an
|
|
1616
|
+
# approximation.
|
|
1617
|
+
#
|
|
1618
|
+
# This feature only applies to messages that arrived in the data store
|
|
1619
|
+
# after October 23, 2020.
|
|
1620
|
+
# @return [Time]
|
|
1621
|
+
#
|
|
1622
|
+
# @!attribute [rw] file_format_configuration
|
|
1623
|
+
# Contains the configuration information of file formats. AWS IoT
|
|
1624
|
+
# Analytics data stores support JSON and [Parquet][1].
|
|
1625
|
+
#
|
|
1626
|
+
# The default file format is JSON. You can specify only one format.
|
|
1627
|
+
#
|
|
1628
|
+
# You can't change the file format after you create the data store.
|
|
1629
|
+
#
|
|
1630
|
+
#
|
|
1631
|
+
#
|
|
1632
|
+
# [1]: https://parquet.apache.org/
|
|
1633
|
+
# @return [Types::FileFormatConfiguration]
|
|
1634
|
+
#
|
|
1635
|
+
# @!attribute [rw] datastore_partitions
|
|
1636
|
+
# Contains information about the partitions in a data store.
|
|
1637
|
+
# @return [Types::DatastorePartitions]
|
|
1638
|
+
#
|
|
1439
1639
|
class Datastore < Struct.new(
|
|
1440
1640
|
:name,
|
|
1441
1641
|
:storage,
|
|
@@ -1443,12 +1643,15 @@ module Aws::IoTAnalytics
|
|
|
1443
1643
|
:status,
|
|
1444
1644
|
:retention_period,
|
|
1445
1645
|
:creation_time,
|
|
1446
|
-
:last_update_time
|
|
1646
|
+
:last_update_time,
|
|
1647
|
+
:last_message_arrival_time,
|
|
1648
|
+
:file_format_configuration,
|
|
1649
|
+
:datastore_partitions)
|
|
1447
1650
|
SENSITIVE = []
|
|
1448
1651
|
include Aws::Structure
|
|
1449
1652
|
end
|
|
1450
1653
|
|
|
1451
|
-
# The
|
|
1654
|
+
# The datastore activity that specifies where to store the processed
|
|
1452
1655
|
# data.
|
|
1453
1656
|
#
|
|
1454
1657
|
# @note When making an API call, you may pass DatastoreActivity
|
|
@@ -1460,7 +1663,7 @@ module Aws::IoTAnalytics
|
|
|
1460
1663
|
# }
|
|
1461
1664
|
#
|
|
1462
1665
|
# @!attribute [rw] name
|
|
1463
|
-
# The name of the
|
|
1666
|
+
# The name of the datastore activity.
|
|
1464
1667
|
# @return [String]
|
|
1465
1668
|
#
|
|
1466
1669
|
# @!attribute [rw] datastore_name
|
|
@@ -1474,6 +1677,65 @@ module Aws::IoTAnalytics
|
|
|
1474
1677
|
include Aws::Structure
|
|
1475
1678
|
end
|
|
1476
1679
|
|
|
1680
|
+
# A single partition in a data store.
|
|
1681
|
+
#
|
|
1682
|
+
# @note When making an API call, you may pass DatastorePartition
|
|
1683
|
+
# data as a hash:
|
|
1684
|
+
#
|
|
1685
|
+
# {
|
|
1686
|
+
# attribute_partition: {
|
|
1687
|
+
# attribute_name: "PartitionAttributeName", # required
|
|
1688
|
+
# },
|
|
1689
|
+
# timestamp_partition: {
|
|
1690
|
+
# attribute_name: "PartitionAttributeName", # required
|
|
1691
|
+
# timestamp_format: "TimestampFormat",
|
|
1692
|
+
# },
|
|
1693
|
+
# }
|
|
1694
|
+
#
|
|
1695
|
+
# @!attribute [rw] attribute_partition
|
|
1696
|
+
# A partition defined by an `attributeName`.
|
|
1697
|
+
# @return [Types::Partition]
|
|
1698
|
+
#
|
|
1699
|
+
# @!attribute [rw] timestamp_partition
|
|
1700
|
+
# A partition defined by an `attributeName` and a timestamp format.
|
|
1701
|
+
# @return [Types::TimestampPartition]
|
|
1702
|
+
#
|
|
1703
|
+
class DatastorePartition < Struct.new(
|
|
1704
|
+
:attribute_partition,
|
|
1705
|
+
:timestamp_partition)
|
|
1706
|
+
SENSITIVE = []
|
|
1707
|
+
include Aws::Structure
|
|
1708
|
+
end
|
|
1709
|
+
|
|
1710
|
+
# Contains information about partitions in a data store.
|
|
1711
|
+
#
|
|
1712
|
+
# @note When making an API call, you may pass DatastorePartitions
|
|
1713
|
+
# data as a hash:
|
|
1714
|
+
#
|
|
1715
|
+
# {
|
|
1716
|
+
# partitions: [
|
|
1717
|
+
# {
|
|
1718
|
+
# attribute_partition: {
|
|
1719
|
+
# attribute_name: "PartitionAttributeName", # required
|
|
1720
|
+
# },
|
|
1721
|
+
# timestamp_partition: {
|
|
1722
|
+
# attribute_name: "PartitionAttributeName", # required
|
|
1723
|
+
# timestamp_format: "TimestampFormat",
|
|
1724
|
+
# },
|
|
1725
|
+
# },
|
|
1726
|
+
# ],
|
|
1727
|
+
# }
|
|
1728
|
+
#
|
|
1729
|
+
# @!attribute [rw] partitions
|
|
1730
|
+
# A list of partitions in a data store.
|
|
1731
|
+
# @return [Array<Types::DatastorePartition>]
|
|
1732
|
+
#
|
|
1733
|
+
class DatastorePartitions < Struct.new(
|
|
1734
|
+
:partitions)
|
|
1735
|
+
SENSITIVE = []
|
|
1736
|
+
include Aws::Structure
|
|
1737
|
+
end
|
|
1738
|
+
|
|
1477
1739
|
# Statistical information about the data store.
|
|
1478
1740
|
#
|
|
1479
1741
|
# @!attribute [rw] size
|
|
@@ -1486,10 +1748,10 @@ module Aws::IoTAnalytics
|
|
|
1486
1748
|
include Aws::Structure
|
|
1487
1749
|
end
|
|
1488
1750
|
|
|
1489
|
-
# Where data store data is stored. You
|
|
1490
|
-
#
|
|
1491
|
-
#
|
|
1492
|
-
# after the data store is created.
|
|
1751
|
+
# Where data store data is stored. You can choose one of
|
|
1752
|
+
# `serviceManagedS3` or `customerManagedS3` storage. If not specified,
|
|
1753
|
+
# the default is `serviceManagedS3`. You cannot change this storage
|
|
1754
|
+
# option after the data store is created.
|
|
1493
1755
|
#
|
|
1494
1756
|
# @note When making an API call, you may pass DatastoreStorage
|
|
1495
1757
|
# data as a hash:
|
|
@@ -1505,15 +1767,14 @@ module Aws::IoTAnalytics
|
|
|
1505
1767
|
# }
|
|
1506
1768
|
#
|
|
1507
1769
|
# @!attribute [rw] service_managed_s3
|
|
1508
|
-
# Use this to store data store data in an S3 bucket managed by
|
|
1509
|
-
#
|
|
1510
|
-
# customer-managed S3 storage
|
|
1511
|
-
# data store.
|
|
1770
|
+
# Use this to store data store data in an S3 bucket managed by AWS IoT
|
|
1771
|
+
# Analytics. You cannot change the choice of service-managed or
|
|
1772
|
+
# customer-managed S3 storage after the data store is created.
|
|
1512
1773
|
# @return [Types::ServiceManagedDatastoreS3Storage]
|
|
1513
1774
|
#
|
|
1514
1775
|
# @!attribute [rw] customer_managed_s3
|
|
1515
1776
|
# Use this to store data store data in an S3 bucket that you manage.
|
|
1516
|
-
# When customer managed storage is selected, the
|
|
1777
|
+
# When customer managed storage is selected, the `retentionPeriod`
|
|
1517
1778
|
# parameter is ignored. The choice of service-managed or
|
|
1518
1779
|
# customer-managed S3 storage cannot be changed after creation of the
|
|
1519
1780
|
# data store.
|
|
@@ -1529,8 +1790,8 @@ module Aws::IoTAnalytics
|
|
|
1529
1790
|
# Where data store data is stored.
|
|
1530
1791
|
#
|
|
1531
1792
|
# @!attribute [rw] service_managed_s3
|
|
1532
|
-
# Used to store data store data in an S3 bucket managed by
|
|
1533
|
-
# Analytics
|
|
1793
|
+
# Used to store data store data in an S3 bucket managed by AWS IoT
|
|
1794
|
+
# Analytics.
|
|
1534
1795
|
# @return [Types::ServiceManagedDatastoreS3StorageSummary]
|
|
1535
1796
|
#
|
|
1536
1797
|
# @!attribute [rw] customer_managed_s3
|
|
@@ -1566,12 +1827,34 @@ module Aws::IoTAnalytics
|
|
|
1566
1827
|
# The last time the data store was updated.
|
|
1567
1828
|
# @return [Time]
|
|
1568
1829
|
#
|
|
1830
|
+
# @!attribute [rw] last_message_arrival_time
|
|
1831
|
+
# The last time when a new message arrived in the data store.
|
|
1832
|
+
#
|
|
1833
|
+
# AWS IoT Analytics updates this value at most once per minute for one
|
|
1834
|
+
# data store. Hence, the `lastMessageArrivalTime` value is an
|
|
1835
|
+
# approximation.
|
|
1836
|
+
#
|
|
1837
|
+
# This feature only applies to messages that arrived in the data store
|
|
1838
|
+
# after October 23, 2020.
|
|
1839
|
+
# @return [Time]
|
|
1840
|
+
#
|
|
1841
|
+
# @!attribute [rw] file_format_type
|
|
1842
|
+
# The file format of the data in the data store.
|
|
1843
|
+
# @return [String]
|
|
1844
|
+
#
|
|
1845
|
+
# @!attribute [rw] datastore_partitions
|
|
1846
|
+
# Contains information about the partitions in a data store.
|
|
1847
|
+
# @return [Types::DatastorePartitions]
|
|
1848
|
+
#
|
|
1569
1849
|
class DatastoreSummary < Struct.new(
|
|
1570
1850
|
:datastore_name,
|
|
1571
1851
|
:datastore_storage,
|
|
1572
1852
|
:status,
|
|
1573
1853
|
:creation_time,
|
|
1574
|
-
:last_update_time
|
|
1854
|
+
:last_update_time,
|
|
1855
|
+
:last_message_arrival_time,
|
|
1856
|
+
:file_format_type,
|
|
1857
|
+
:datastore_partitions)
|
|
1575
1858
|
SENSITIVE = []
|
|
1576
1859
|
include Aws::Structure
|
|
1577
1860
|
end
|
|
@@ -1602,11 +1885,11 @@ module Aws::IoTAnalytics
|
|
|
1602
1885
|
# }
|
|
1603
1886
|
#
|
|
1604
1887
|
# @!attribute [rw] dataset_name
|
|
1605
|
-
# The name of the
|
|
1888
|
+
# The name of the dataset whose content is deleted.
|
|
1606
1889
|
# @return [String]
|
|
1607
1890
|
#
|
|
1608
1891
|
# @!attribute [rw] version_id
|
|
1609
|
-
# The version of the
|
|
1892
|
+
# The version of the dataset whose content is deleted. You can also
|
|
1610
1893
|
# use the strings "$LATEST" or "$LATEST\_SUCCEEDED" to delete the
|
|
1611
1894
|
# latest or latest successfully completed data set. If not specified,
|
|
1612
1895
|
# "$LATEST\_SUCCEEDED" is the default.
|
|
@@ -1682,22 +1965,21 @@ module Aws::IoTAnalytics
|
|
|
1682
1965
|
# }
|
|
1683
1966
|
#
|
|
1684
1967
|
# @!attribute [rw] offset_seconds
|
|
1685
|
-
# The number of seconds of estimated
|
|
1686
|
-
# data. When you create
|
|
1687
|
-
# specified
|
|
1688
|
-
#
|
|
1689
|
-
#
|
|
1690
|
-
#
|
|
1691
|
-
#
|
|
1692
|
-
#
|
|
1693
|
-
#
|
|
1694
|
-
# within the previous time frame.
|
|
1968
|
+
# The number of seconds of estimated in-flight lag time of message
|
|
1969
|
+
# data. When you create dataset contents using message data from a
|
|
1970
|
+
# specified timeframe, some message data might still be in flight when
|
|
1971
|
+
# processing begins, and so do not arrive in time to be processed. Use
|
|
1972
|
+
# this field to make allowances for the in flight time of your message
|
|
1973
|
+
# data, so that data not processed from a previous timeframe is
|
|
1974
|
+
# included with the next timeframe. Otherwise, missed message data
|
|
1975
|
+
# would be excluded from processing during the next timeframe too,
|
|
1976
|
+
# because its timestamp places it within the previous timeframe.
|
|
1695
1977
|
# @return [Integer]
|
|
1696
1978
|
#
|
|
1697
1979
|
# @!attribute [rw] time_expression
|
|
1698
|
-
# An expression by which the time of the message data
|
|
1699
|
-
# determined. This
|
|
1700
|
-
# expression
|
|
1980
|
+
# An expression by which the time of the message data might be
|
|
1981
|
+
# determined. This can be the name of a timestamp field or a SQL
|
|
1982
|
+
# expression that is used to derive the time the message data was
|
|
1701
1983
|
# generated.
|
|
1702
1984
|
# @return [String]
|
|
1703
1985
|
#
|
|
@@ -1708,6 +1990,48 @@ module Aws::IoTAnalytics
|
|
|
1708
1990
|
include Aws::Structure
|
|
1709
1991
|
end
|
|
1710
1992
|
|
|
1993
|
+
# A structure that contains the configuration information of a delta
|
|
1994
|
+
# time session window.
|
|
1995
|
+
#
|
|
1996
|
+
# [ `DeltaTime` ][1] specifies a time interval. You can use `DeltaTime`
|
|
1997
|
+
# to create dataset contents with data that has arrived in the data
|
|
1998
|
+
# store since the last execution. For an example of `DeltaTime`, see [
|
|
1999
|
+
# Creating a SQL dataset with a delta window (CLI)][2] in the *AWS IoT
|
|
2000
|
+
# Analytics User Guide*.
|
|
2001
|
+
#
|
|
2002
|
+
#
|
|
2003
|
+
#
|
|
2004
|
+
# [1]: https://docs.aws.amazon.com/iotanalytics/latest/APIReference/API_DeltaTime.html
|
|
2005
|
+
# [2]: https://docs.aws.amazon.com/iotanalytics/latest/userguide/automate-create-dataset.html#automate-example6
|
|
2006
|
+
#
|
|
2007
|
+
# @note When making an API call, you may pass DeltaTimeSessionWindowConfiguration
|
|
2008
|
+
# data as a hash:
|
|
2009
|
+
#
|
|
2010
|
+
# {
|
|
2011
|
+
# timeout_in_minutes: 1, # required
|
|
2012
|
+
# }
|
|
2013
|
+
#
|
|
2014
|
+
# @!attribute [rw] timeout_in_minutes
|
|
2015
|
+
# A time interval. You can use `timeoutInMinutes` so that AWS IoT
|
|
2016
|
+
# Analytics can batch up late data notifications that have been
|
|
2017
|
+
# generated since the last execution. AWS IoT Analytics sends one
|
|
2018
|
+
# batch of notifications to Amazon CloudWatch Events at one time.
|
|
2019
|
+
#
|
|
2020
|
+
# For more information about how to write a timestamp expression, see
|
|
2021
|
+
# [Date and Time Functions and Operators][1], in the *Presto 0.172
|
|
2022
|
+
# Documentation*.
|
|
2023
|
+
#
|
|
2024
|
+
#
|
|
2025
|
+
#
|
|
2026
|
+
# [1]: https://prestodb.io/docs/0.172/functions/datetime.html
|
|
2027
|
+
# @return [Integer]
|
|
2028
|
+
#
|
|
2029
|
+
class DeltaTimeSessionWindowConfiguration < Struct.new(
|
|
2030
|
+
:timeout_in_minutes)
|
|
2031
|
+
SENSITIVE = []
|
|
2032
|
+
include Aws::Structure
|
|
2033
|
+
end
|
|
2034
|
+
|
|
1711
2035
|
# @note When making an API call, you may pass DescribeChannelRequest
|
|
1712
2036
|
# data as a hash:
|
|
1713
2037
|
#
|
|
@@ -1738,8 +2062,8 @@ module Aws::IoTAnalytics
|
|
|
1738
2062
|
# @return [Types::Channel]
|
|
1739
2063
|
#
|
|
1740
2064
|
# @!attribute [rw] statistics
|
|
1741
|
-
# Statistics about the channel. Included if the
|
|
1742
|
-
# parameter is set to true in the request.
|
|
2065
|
+
# Statistics about the channel. Included if the `includeStatistics`
|
|
2066
|
+
# parameter is set to `true` in the request.
|
|
1743
2067
|
# @return [Types::ChannelStatistics]
|
|
1744
2068
|
#
|
|
1745
2069
|
class DescribeChannelResponse < Struct.new(
|
|
@@ -1807,7 +2131,7 @@ module Aws::IoTAnalytics
|
|
|
1807
2131
|
#
|
|
1808
2132
|
# @!attribute [rw] statistics
|
|
1809
2133
|
# Additional statistical information about the data store. Included if
|
|
1810
|
-
# the
|
|
2134
|
+
# the `includeStatistics` parameter is set to `true` in the request.
|
|
1811
2135
|
# @return [Types::DatastoreStatistics]
|
|
1812
2136
|
#
|
|
1813
2137
|
class DescribeDatastoreResponse < Struct.new(
|
|
@@ -1849,7 +2173,7 @@ module Aws::IoTAnalytics
|
|
|
1849
2173
|
end
|
|
1850
2174
|
|
|
1851
2175
|
# @!attribute [rw] pipeline
|
|
1852
|
-
# A
|
|
2176
|
+
# A `Pipeline` object that contains information about the pipeline.
|
|
1853
2177
|
# @return [Types::Pipeline]
|
|
1854
2178
|
#
|
|
1855
2179
|
class DescribePipelineResponse < Struct.new(
|
|
@@ -1873,7 +2197,7 @@ module Aws::IoTAnalytics
|
|
|
1873
2197
|
# }
|
|
1874
2198
|
#
|
|
1875
2199
|
# @!attribute [rw] name
|
|
1876
|
-
# The name of the
|
|
2200
|
+
# The name of the `deviceRegistryEnrich` activity.
|
|
1877
2201
|
# @return [String]
|
|
1878
2202
|
#
|
|
1879
2203
|
# @!attribute [rw] attribute
|
|
@@ -1904,7 +2228,7 @@ module Aws::IoTAnalytics
|
|
|
1904
2228
|
include Aws::Structure
|
|
1905
2229
|
end
|
|
1906
2230
|
|
|
1907
|
-
# An activity that adds information from the AWS IoT Device
|
|
2231
|
+
# An activity that adds information from the AWS IoT Device Shadow
|
|
1908
2232
|
# service to a message.
|
|
1909
2233
|
#
|
|
1910
2234
|
# @note When making an API call, you may pass DeviceShadowEnrichActivity
|
|
@@ -1919,7 +2243,7 @@ module Aws::IoTAnalytics
|
|
|
1919
2243
|
# }
|
|
1920
2244
|
#
|
|
1921
2245
|
# @!attribute [rw] name
|
|
1922
|
-
# The name of the
|
|
2246
|
+
# The name of the `deviceShadowEnrich` activity.
|
|
1923
2247
|
# @return [String]
|
|
1924
2248
|
#
|
|
1925
2249
|
# @!attribute [rw] attribute
|
|
@@ -1952,7 +2276,7 @@ module Aws::IoTAnalytics
|
|
|
1952
2276
|
# The estimated size of the resource.
|
|
1953
2277
|
#
|
|
1954
2278
|
# @!attribute [rw] estimated_size_in_bytes
|
|
1955
|
-
# The estimated size of the resource in bytes.
|
|
2279
|
+
# The estimated size of the resource, in bytes.
|
|
1956
2280
|
# @return [Float]
|
|
1957
2281
|
#
|
|
1958
2282
|
# @!attribute [rw] estimated_on
|
|
@@ -1966,6 +2290,50 @@ module Aws::IoTAnalytics
|
|
|
1966
2290
|
include Aws::Structure
|
|
1967
2291
|
end
|
|
1968
2292
|
|
|
2293
|
+
# Contains the configuration information of file formats. AWS IoT
|
|
2294
|
+
# Analytics data stores support JSON and [Parquet][1].
|
|
2295
|
+
#
|
|
2296
|
+
# The default file format is JSON. You can specify only one format.
|
|
2297
|
+
#
|
|
2298
|
+
# You can't change the file format after you create the data store.
|
|
2299
|
+
#
|
|
2300
|
+
#
|
|
2301
|
+
#
|
|
2302
|
+
# [1]: https://parquet.apache.org/
|
|
2303
|
+
#
|
|
2304
|
+
# @note When making an API call, you may pass FileFormatConfiguration
|
|
2305
|
+
# data as a hash:
|
|
2306
|
+
#
|
|
2307
|
+
# {
|
|
2308
|
+
# json_configuration: {
|
|
2309
|
+
# },
|
|
2310
|
+
# parquet_configuration: {
|
|
2311
|
+
# schema_definition: {
|
|
2312
|
+
# columns: [
|
|
2313
|
+
# {
|
|
2314
|
+
# name: "ColumnName", # required
|
|
2315
|
+
# type: "ColumnDataType", # required
|
|
2316
|
+
# },
|
|
2317
|
+
# ],
|
|
2318
|
+
# },
|
|
2319
|
+
# },
|
|
2320
|
+
# }
|
|
2321
|
+
#
|
|
2322
|
+
# @!attribute [rw] json_configuration
|
|
2323
|
+
# Contains the configuration information of the JSON format.
|
|
2324
|
+
# @return [Types::JsonConfiguration]
|
|
2325
|
+
#
|
|
2326
|
+
# @!attribute [rw] parquet_configuration
|
|
2327
|
+
# Contains the configuration information of the Parquet format.
|
|
2328
|
+
# @return [Types::ParquetConfiguration]
|
|
2329
|
+
#
|
|
2330
|
+
class FileFormatConfiguration < Struct.new(
|
|
2331
|
+
:json_configuration,
|
|
2332
|
+
:parquet_configuration)
|
|
2333
|
+
SENSITIVE = []
|
|
2334
|
+
include Aws::Structure
|
|
2335
|
+
end
|
|
2336
|
+
|
|
1969
2337
|
# An activity that filters a message based on its attributes.
|
|
1970
2338
|
#
|
|
1971
2339
|
# @note When making an API call, you may pass FilterActivity
|
|
@@ -1978,12 +2346,13 @@ module Aws::IoTAnalytics
|
|
|
1978
2346
|
# }
|
|
1979
2347
|
#
|
|
1980
2348
|
# @!attribute [rw] name
|
|
1981
|
-
# The name of the
|
|
2349
|
+
# The name of the filter activity.
|
|
1982
2350
|
# @return [String]
|
|
1983
2351
|
#
|
|
1984
2352
|
# @!attribute [rw] filter
|
|
1985
2353
|
# An expression that looks like a SQL WHERE clause that must return a
|
|
1986
|
-
# Boolean value.
|
|
2354
|
+
# Boolean value. Messages that satisfy the condition are passed to the
|
|
2355
|
+
# next activity.
|
|
1987
2356
|
# @return [String]
|
|
1988
2357
|
#
|
|
1989
2358
|
# @!attribute [rw] next
|
|
@@ -2025,7 +2394,7 @@ module Aws::IoTAnalytics
|
|
|
2025
2394
|
end
|
|
2026
2395
|
|
|
2027
2396
|
# @!attribute [rw] entries
|
|
2028
|
-
# A list of
|
|
2397
|
+
# A list of `DatasetEntry` objects.
|
|
2029
2398
|
# @return [Array<Types::DatasetEntry>]
|
|
2030
2399
|
#
|
|
2031
2400
|
# @!attribute [rw] timestamp
|
|
@@ -2044,8 +2413,8 @@ module Aws::IoTAnalytics
|
|
|
2044
2413
|
include Aws::Structure
|
|
2045
2414
|
end
|
|
2046
2415
|
|
|
2047
|
-
# Configuration information for coordination with
|
|
2048
|
-
#
|
|
2416
|
+
# Configuration information for coordination with AWS Glue, a fully
|
|
2417
|
+
# managed extract, transform and load (ETL) service.
|
|
2049
2418
|
#
|
|
2050
2419
|
# @note When making an API call, you may pass GlueConfiguration
|
|
2051
2420
|
# data as a hash:
|
|
@@ -2056,16 +2425,15 @@ module Aws::IoTAnalytics
|
|
|
2056
2425
|
# }
|
|
2057
2426
|
#
|
|
2058
2427
|
# @!attribute [rw] table_name
|
|
2059
|
-
# The name of the table in your AWS Glue Data Catalog
|
|
2060
|
-
# perform the ETL
|
|
2061
|
-
#
|
|
2062
|
-
# of data sources and targets.)
|
|
2428
|
+
# The name of the table in your AWS Glue Data Catalog that is used to
|
|
2429
|
+
# perform the ETL operations. An AWS Glue Data Catalog table contains
|
|
2430
|
+
# partitioned data and descriptions of data sources and targets.
|
|
2063
2431
|
# @return [String]
|
|
2064
2432
|
#
|
|
2065
2433
|
# @!attribute [rw] database_name
|
|
2066
2434
|
# The name of the database in your AWS Glue Data Catalog in which the
|
|
2067
|
-
# table is located.
|
|
2068
|
-
#
|
|
2435
|
+
# table is located. An AWS Glue Data Catalog database contains
|
|
2436
|
+
# metadata tables.
|
|
2069
2437
|
# @return [String]
|
|
2070
2438
|
#
|
|
2071
2439
|
class GlueConfiguration < Struct.new(
|
|
@@ -2097,7 +2465,7 @@ module Aws::IoTAnalytics
|
|
|
2097
2465
|
include Aws::Structure
|
|
2098
2466
|
end
|
|
2099
2467
|
|
|
2100
|
-
# Configuration information for delivery of
|
|
2468
|
+
# Configuration information for delivery of dataset contents to AWS IoT
|
|
2101
2469
|
# Events.
|
|
2102
2470
|
#
|
|
2103
2471
|
# @note When making an API call, you may pass IotEventsDestinationConfiguration
|
|
@@ -2109,13 +2477,13 @@ module Aws::IoTAnalytics
|
|
|
2109
2477
|
# }
|
|
2110
2478
|
#
|
|
2111
2479
|
# @!attribute [rw] input_name
|
|
2112
|
-
# The name of the AWS IoT Events input to which
|
|
2480
|
+
# The name of the AWS IoT Events input to which dataset contents are
|
|
2113
2481
|
# delivered.
|
|
2114
2482
|
# @return [String]
|
|
2115
2483
|
#
|
|
2116
2484
|
# @!attribute [rw] role_arn
|
|
2117
|
-
# The ARN of the role
|
|
2118
|
-
# deliver
|
|
2485
|
+
# The ARN of the role that grants AWS IoT Analytics permission to
|
|
2486
|
+
# deliver dataset contents to an AWS IoT Events input.
|
|
2119
2487
|
# @return [String]
|
|
2120
2488
|
#
|
|
2121
2489
|
class IotEventsDestinationConfiguration < Struct.new(
|
|
@@ -2125,6 +2493,12 @@ module Aws::IoTAnalytics
|
|
|
2125
2493
|
include Aws::Structure
|
|
2126
2494
|
end
|
|
2127
2495
|
|
|
2496
|
+
# Contains the configuration information of the JSON format.
|
|
2497
|
+
#
|
|
2498
|
+
# @api private
|
|
2499
|
+
#
|
|
2500
|
+
class JsonConfiguration < Aws::EmptyStructure; end
|
|
2501
|
+
|
|
2128
2502
|
# An activity that runs a Lambda function to modify the message.
|
|
2129
2503
|
#
|
|
2130
2504
|
# @note When making an API call, you may pass LambdaActivity
|
|
@@ -2138,7 +2512,7 @@ module Aws::IoTAnalytics
|
|
|
2138
2512
|
# }
|
|
2139
2513
|
#
|
|
2140
2514
|
# @!attribute [rw] name
|
|
2141
|
-
# The name of the
|
|
2515
|
+
# The name of the lambda activity.
|
|
2142
2516
|
# @return [String]
|
|
2143
2517
|
#
|
|
2144
2518
|
# @!attribute [rw] lambda_name
|
|
@@ -2148,9 +2522,9 @@ module Aws::IoTAnalytics
|
|
|
2148
2522
|
# @!attribute [rw] batch_size
|
|
2149
2523
|
# The number of messages passed to the Lambda function for processing.
|
|
2150
2524
|
#
|
|
2151
|
-
# The
|
|
2152
|
-
#
|
|
2153
|
-
#
|
|
2525
|
+
# The Lambda function must be able to process all of these messages
|
|
2526
|
+
# within five minutes, which is the maximum timeout duration for
|
|
2527
|
+
# Lambda functions.
|
|
2154
2528
|
# @return [Integer]
|
|
2155
2529
|
#
|
|
2156
2530
|
# @!attribute [rw] next
|
|
@@ -2166,6 +2540,57 @@ module Aws::IoTAnalytics
|
|
|
2166
2540
|
include Aws::Structure
|
|
2167
2541
|
end
|
|
2168
2542
|
|
|
2543
|
+
# A structure that contains the name and configuration information of a
|
|
2544
|
+
# late data rule.
|
|
2545
|
+
#
|
|
2546
|
+
# @note When making an API call, you may pass LateDataRule
|
|
2547
|
+
# data as a hash:
|
|
2548
|
+
#
|
|
2549
|
+
# {
|
|
2550
|
+
# rule_name: "LateDataRuleName",
|
|
2551
|
+
# rule_configuration: { # required
|
|
2552
|
+
# delta_time_session_window_configuration: {
|
|
2553
|
+
# timeout_in_minutes: 1, # required
|
|
2554
|
+
# },
|
|
2555
|
+
# },
|
|
2556
|
+
# }
|
|
2557
|
+
#
|
|
2558
|
+
# @!attribute [rw] rule_name
|
|
2559
|
+
# The name of the late data rule.
|
|
2560
|
+
# @return [String]
|
|
2561
|
+
#
|
|
2562
|
+
# @!attribute [rw] rule_configuration
|
|
2563
|
+
# The information needed to configure the late data rule.
|
|
2564
|
+
# @return [Types::LateDataRuleConfiguration]
|
|
2565
|
+
#
|
|
2566
|
+
class LateDataRule < Struct.new(
|
|
2567
|
+
:rule_name,
|
|
2568
|
+
:rule_configuration)
|
|
2569
|
+
SENSITIVE = []
|
|
2570
|
+
include Aws::Structure
|
|
2571
|
+
end
|
|
2572
|
+
|
|
2573
|
+
# The information needed to configure a delta time session window.
|
|
2574
|
+
#
|
|
2575
|
+
# @note When making an API call, you may pass LateDataRuleConfiguration
|
|
2576
|
+
# data as a hash:
|
|
2577
|
+
#
|
|
2578
|
+
# {
|
|
2579
|
+
# delta_time_session_window_configuration: {
|
|
2580
|
+
# timeout_in_minutes: 1, # required
|
|
2581
|
+
# },
|
|
2582
|
+
# }
|
|
2583
|
+
#
|
|
2584
|
+
# @!attribute [rw] delta_time_session_window_configuration
|
|
2585
|
+
# The information needed to configure a delta time session window.
|
|
2586
|
+
# @return [Types::DeltaTimeSessionWindowConfiguration]
|
|
2587
|
+
#
|
|
2588
|
+
class LateDataRuleConfiguration < Struct.new(
|
|
2589
|
+
:delta_time_session_window_configuration)
|
|
2590
|
+
SENSITIVE = []
|
|
2591
|
+
include Aws::Structure
|
|
2592
|
+
end
|
|
2593
|
+
|
|
2169
2594
|
# The command caused an internal limit to be exceeded.
|
|
2170
2595
|
#
|
|
2171
2596
|
# @!attribute [rw] message
|
|
@@ -2203,7 +2628,7 @@ module Aws::IoTAnalytics
|
|
|
2203
2628
|
end
|
|
2204
2629
|
|
|
2205
2630
|
# @!attribute [rw] channel_summaries
|
|
2206
|
-
# A list of
|
|
2631
|
+
# A list of `ChannelSummary` objects.
|
|
2207
2632
|
# @return [Array<Types::ChannelSummary>]
|
|
2208
2633
|
#
|
|
2209
2634
|
# @!attribute [rw] next_token
|
|
@@ -2245,13 +2670,13 @@ module Aws::IoTAnalytics
|
|
|
2245
2670
|
# @!attribute [rw] scheduled_on_or_after
|
|
2246
2671
|
# A filter to limit results to those data set contents whose creation
|
|
2247
2672
|
# is scheduled on or after the given time. See the field
|
|
2248
|
-
# `triggers.schedule` in the CreateDataset request. (timestamp)
|
|
2673
|
+
# `triggers.schedule` in the `CreateDataset` request. (timestamp)
|
|
2249
2674
|
# @return [Time]
|
|
2250
2675
|
#
|
|
2251
2676
|
# @!attribute [rw] scheduled_before
|
|
2252
2677
|
# A filter to limit results to those data set contents whose creation
|
|
2253
2678
|
# is scheduled before the given time. See the field
|
|
2254
|
-
# `triggers.schedule` in the CreateDataset request. (timestamp)
|
|
2679
|
+
# `triggers.schedule` in the `CreateDataset` request. (timestamp)
|
|
2255
2680
|
# @return [Time]
|
|
2256
2681
|
#
|
|
2257
2682
|
class ListDatasetContentsRequest < Struct.new(
|
|
@@ -2306,7 +2731,7 @@ module Aws::IoTAnalytics
|
|
|
2306
2731
|
end
|
|
2307
2732
|
|
|
2308
2733
|
# @!attribute [rw] dataset_summaries
|
|
2309
|
-
# A list of
|
|
2734
|
+
# A list of `DatasetSummary` objects.
|
|
2310
2735
|
# @return [Array<Types::DatasetSummary>]
|
|
2311
2736
|
#
|
|
2312
2737
|
# @!attribute [rw] next_token
|
|
@@ -2347,7 +2772,7 @@ module Aws::IoTAnalytics
|
|
|
2347
2772
|
end
|
|
2348
2773
|
|
|
2349
2774
|
# @!attribute [rw] datastore_summaries
|
|
2350
|
-
# A list of
|
|
2775
|
+
# A list of `DatastoreSummary` objects.
|
|
2351
2776
|
# @return [Array<Types::DatastoreSummary>]
|
|
2352
2777
|
#
|
|
2353
2778
|
# @!attribute [rw] next_token
|
|
@@ -2388,7 +2813,7 @@ module Aws::IoTAnalytics
|
|
|
2388
2813
|
end
|
|
2389
2814
|
|
|
2390
2815
|
# @!attribute [rw] pipeline_summaries
|
|
2391
|
-
# A list of
|
|
2816
|
+
# A list of `PipelineSummary` objects.
|
|
2392
2817
|
# @return [Array<Types::PipelineSummary>]
|
|
2393
2818
|
#
|
|
2394
2819
|
# @!attribute [rw] next_token
|
|
@@ -2421,7 +2846,7 @@ module Aws::IoTAnalytics
|
|
|
2421
2846
|
end
|
|
2422
2847
|
|
|
2423
2848
|
# @!attribute [rw] tags
|
|
2424
|
-
# The tags (metadata)
|
|
2849
|
+
# The tags (metadata) that you have assigned to the resource.
|
|
2425
2850
|
# @return [Array<Types::Tag>]
|
|
2426
2851
|
#
|
|
2427
2852
|
class ListTagsForResourceResponse < Struct.new(
|
|
@@ -2447,7 +2872,7 @@ module Aws::IoTAnalytics
|
|
|
2447
2872
|
# @return [String]
|
|
2448
2873
|
#
|
|
2449
2874
|
# @!attribute [rw] level
|
|
2450
|
-
# The logging level. Currently, only
|
|
2875
|
+
# The logging level. Currently, only ERROR is supported.
|
|
2451
2876
|
# @return [String]
|
|
2452
2877
|
#
|
|
2453
2878
|
# @!attribute [rw] enabled
|
|
@@ -2476,7 +2901,7 @@ module Aws::IoTAnalytics
|
|
|
2476
2901
|
# }
|
|
2477
2902
|
#
|
|
2478
2903
|
# @!attribute [rw] name
|
|
2479
|
-
# The name of the
|
|
2904
|
+
# The name of the math activity.
|
|
2480
2905
|
# @return [String]
|
|
2481
2906
|
#
|
|
2482
2907
|
# @!attribute [rw] attribute
|
|
@@ -2513,14 +2938,14 @@ module Aws::IoTAnalytics
|
|
|
2513
2938
|
# }
|
|
2514
2939
|
#
|
|
2515
2940
|
# @!attribute [rw] message_id
|
|
2516
|
-
# The ID you
|
|
2941
|
+
# The ID you want to assign to the message. Each `messageId` must be
|
|
2517
2942
|
# unique within each batch sent.
|
|
2518
2943
|
# @return [String]
|
|
2519
2944
|
#
|
|
2520
2945
|
# @!attribute [rw] payload
|
|
2521
|
-
# The payload of the message. This
|
|
2522
|
-
#
|
|
2523
|
-
# must decode it by means of a pipeline activity
|
|
2946
|
+
# The payload of the message. This can be a JSON string or a
|
|
2947
|
+
# base64-encoded string representing binary data, in which case you
|
|
2948
|
+
# must decode it by means of a pipeline activity.
|
|
2524
2949
|
# @return [String]
|
|
2525
2950
|
#
|
|
2526
2951
|
class Message < Struct.new(
|
|
@@ -2541,7 +2966,7 @@ module Aws::IoTAnalytics
|
|
|
2541
2966
|
# }
|
|
2542
2967
|
#
|
|
2543
2968
|
# @!attribute [rw] file_name
|
|
2544
|
-
# The URI of the location where
|
|
2969
|
+
# The URI of the location where dataset contents are stored, usually
|
|
2545
2970
|
# the URI of a file in an S3 bucket.
|
|
2546
2971
|
# @return [String]
|
|
2547
2972
|
#
|
|
@@ -2551,6 +2976,51 @@ module Aws::IoTAnalytics
|
|
|
2551
2976
|
include Aws::Structure
|
|
2552
2977
|
end
|
|
2553
2978
|
|
|
2979
|
+
# Contains the configuration information of the Parquet format.
|
|
2980
|
+
#
|
|
2981
|
+
# @note When making an API call, you may pass ParquetConfiguration
|
|
2982
|
+
# data as a hash:
|
|
2983
|
+
#
|
|
2984
|
+
# {
|
|
2985
|
+
# schema_definition: {
|
|
2986
|
+
# columns: [
|
|
2987
|
+
# {
|
|
2988
|
+
# name: "ColumnName", # required
|
|
2989
|
+
# type: "ColumnDataType", # required
|
|
2990
|
+
# },
|
|
2991
|
+
# ],
|
|
2992
|
+
# },
|
|
2993
|
+
# }
|
|
2994
|
+
#
|
|
2995
|
+
# @!attribute [rw] schema_definition
|
|
2996
|
+
# Information needed to define a schema.
|
|
2997
|
+
# @return [Types::SchemaDefinition]
|
|
2998
|
+
#
|
|
2999
|
+
class ParquetConfiguration < Struct.new(
|
|
3000
|
+
:schema_definition)
|
|
3001
|
+
SENSITIVE = []
|
|
3002
|
+
include Aws::Structure
|
|
3003
|
+
end
|
|
3004
|
+
|
|
3005
|
+
# A single partition.
|
|
3006
|
+
#
|
|
3007
|
+
# @note When making an API call, you may pass Partition
|
|
3008
|
+
# data as a hash:
|
|
3009
|
+
#
|
|
3010
|
+
# {
|
|
3011
|
+
# attribute_name: "PartitionAttributeName", # required
|
|
3012
|
+
# }
|
|
3013
|
+
#
|
|
3014
|
+
# @!attribute [rw] attribute_name
|
|
3015
|
+
# The attribute name of the partition.
|
|
3016
|
+
# @return [String]
|
|
3017
|
+
#
|
|
3018
|
+
class Partition < Struct.new(
|
|
3019
|
+
:attribute_name)
|
|
3020
|
+
SENSITIVE = []
|
|
3021
|
+
include Aws::Structure
|
|
3022
|
+
end
|
|
3023
|
+
|
|
2554
3024
|
# Contains information about a pipeline.
|
|
2555
3025
|
#
|
|
2556
3026
|
# @!attribute [rw] name
|
|
@@ -2692,7 +3162,7 @@ module Aws::IoTAnalytics
|
|
|
2692
3162
|
# @return [Types::DeviceRegistryEnrichActivity]
|
|
2693
3163
|
#
|
|
2694
3164
|
# @!attribute [rw] device_shadow_enrich
|
|
2695
|
-
# Adds information from the AWS IoT Device
|
|
3165
|
+
# Adds information from the AWS IoT Device Shadow service to a
|
|
2696
3166
|
# message.
|
|
2697
3167
|
# @return [Types::DeviceShadowEnrichActivity]
|
|
2698
3168
|
#
|
|
@@ -2759,8 +3229,8 @@ module Aws::IoTAnalytics
|
|
|
2759
3229
|
include Aws::Structure
|
|
2760
3230
|
end
|
|
2761
3231
|
|
|
2762
|
-
# Information
|
|
2763
|
-
# according to the
|
|
3232
|
+
# Information that is used to filter message data, to segregate it
|
|
3233
|
+
# according to the timeframe in which it arrives.
|
|
2764
3234
|
#
|
|
2765
3235
|
# @note When making an API call, you may pass QueryFilter
|
|
2766
3236
|
# data as a hash:
|
|
@@ -2795,7 +3265,7 @@ module Aws::IoTAnalytics
|
|
|
2795
3265
|
# }
|
|
2796
3266
|
#
|
|
2797
3267
|
# @!attribute [rw] name
|
|
2798
|
-
# The name of the
|
|
3268
|
+
# The name of the `removeAttributes` activity.
|
|
2799
3269
|
# @return [String]
|
|
2800
3270
|
#
|
|
2801
3271
|
# @!attribute [rw] attributes
|
|
@@ -2817,7 +3287,7 @@ module Aws::IoTAnalytics
|
|
|
2817
3287
|
# Information about pipeline reprocessing.
|
|
2818
3288
|
#
|
|
2819
3289
|
# @!attribute [rw] id
|
|
2820
|
-
# The
|
|
3290
|
+
# The `reprocessingId` returned by `StartPipelineReprocessing`.
|
|
2821
3291
|
# @return [String]
|
|
2822
3292
|
#
|
|
2823
3293
|
# @!attribute [rw] status
|
|
@@ -2858,7 +3328,7 @@ module Aws::IoTAnalytics
|
|
|
2858
3328
|
end
|
|
2859
3329
|
|
|
2860
3330
|
# The configuration of the resource used to execute the
|
|
2861
|
-
#
|
|
3331
|
+
# `containerAction`.
|
|
2862
3332
|
#
|
|
2863
3333
|
# @note When making an API call, you may pass ResourceConfiguration
|
|
2864
3334
|
# data as a hash:
|
|
@@ -2870,13 +3340,13 @@ module Aws::IoTAnalytics
|
|
|
2870
3340
|
#
|
|
2871
3341
|
# @!attribute [rw] compute_type
|
|
2872
3342
|
# The type of the compute resource used to execute the
|
|
2873
|
-
#
|
|
2874
|
-
#
|
|
3343
|
+
# `containerAction`. Possible values are: `ACU_1` (vCPU=4, memory=16
|
|
3344
|
+
# GiB) or `ACU_2` (vCPU=8, memory=32 GiB).
|
|
2875
3345
|
# @return [String]
|
|
2876
3346
|
#
|
|
2877
3347
|
# @!attribute [rw] volume_size_in_gb
|
|
2878
|
-
# The size
|
|
2879
|
-
# instance used to execute the
|
|
3348
|
+
# The size, in GB, of the persistent storage available to the resource
|
|
3349
|
+
# instance used to execute the `containerAction` (min: 1, max: 50).
|
|
2880
3350
|
# @return [Integer]
|
|
2881
3351
|
#
|
|
2882
3352
|
class ResourceConfiguration < Struct.new(
|
|
@@ -2912,7 +3382,7 @@ module Aws::IoTAnalytics
|
|
|
2912
3382
|
# @return [Boolean]
|
|
2913
3383
|
#
|
|
2914
3384
|
# @!attribute [rw] number_of_days
|
|
2915
|
-
# The number of days that message data is kept. The
|
|
3385
|
+
# The number of days that message data is kept. The `unlimited`
|
|
2916
3386
|
# parameter must be false.
|
|
2917
3387
|
# @return [Integer]
|
|
2918
3388
|
#
|
|
@@ -2990,12 +3460,12 @@ module Aws::IoTAnalytics
|
|
|
2990
3460
|
# }
|
|
2991
3461
|
#
|
|
2992
3462
|
# @!attribute [rw] pipeline_activity
|
|
2993
|
-
# The pipeline activity that is run. This must not be a
|
|
2994
|
-
# activity or a
|
|
2995
|
-
#
|
|
2996
|
-
#
|
|
2997
|
-
#
|
|
2998
|
-
#
|
|
3463
|
+
# The pipeline activity that is run. This must not be a channel
|
|
3464
|
+
# activity or a datastore activity because these activities are used
|
|
3465
|
+
# in a pipeline only to load the original message and to store the
|
|
3466
|
+
# (possibly) transformed message. If a lambda activity is specified,
|
|
3467
|
+
# only short-running Lambda functions (those with a timeout of less
|
|
3468
|
+
# than 30 seconds or less) can be used.
|
|
2999
3469
|
# @return [Types::PipelineActivity]
|
|
3000
3470
|
#
|
|
3001
3471
|
# @!attribute [rw] payloads
|
|
@@ -3027,8 +3497,8 @@ module Aws::IoTAnalytics
|
|
|
3027
3497
|
include Aws::Structure
|
|
3028
3498
|
end
|
|
3029
3499
|
|
|
3030
|
-
# Configuration information for delivery of
|
|
3031
|
-
# S3.
|
|
3500
|
+
# Configuration information for delivery of dataset contents to Amazon
|
|
3501
|
+
# Simple Storage Service (Amazon S3).
|
|
3032
3502
|
#
|
|
3033
3503
|
# @note When making an API call, you may pass S3DestinationConfiguration
|
|
3034
3504
|
# data as a hash:
|
|
@@ -3044,28 +3514,44 @@ module Aws::IoTAnalytics
|
|
|
3044
3514
|
# }
|
|
3045
3515
|
#
|
|
3046
3516
|
# @!attribute [rw] bucket
|
|
3047
|
-
# The name of the
|
|
3048
|
-
# delivered.
|
|
3517
|
+
# The name of the S3 bucket to which dataset contents are delivered.
|
|
3049
3518
|
# @return [String]
|
|
3050
3519
|
#
|
|
3051
3520
|
# @!attribute [rw] key
|
|
3052
|
-
# The key of the
|
|
3053
|
-
#
|
|
3054
|
-
#
|
|
3055
|
-
#
|
|
3056
|
-
#
|
|
3057
|
-
#
|
|
3058
|
-
# the
|
|
3059
|
-
#
|
|
3521
|
+
# The key of the dataset contents object in an S3 bucket. Each object
|
|
3522
|
+
# has a key that is a unique identifier. Each object has exactly one
|
|
3523
|
+
# key.
|
|
3524
|
+
#
|
|
3525
|
+
# You can create a unique key with the following options:
|
|
3526
|
+
#
|
|
3527
|
+
# * Use `!\{iotanalytics:scheduleTime\}` to insert the time of a
|
|
3528
|
+
# scheduled SQL query run.
|
|
3529
|
+
#
|
|
3530
|
+
# * Use `!\{iotanalytics:versionId\}` to insert a unique hash that
|
|
3531
|
+
# identifies a dataset content.
|
|
3532
|
+
#
|
|
3533
|
+
# * Use `!\{iotanalytics:creationTime\}` to insert the creation time
|
|
3534
|
+
# of a dataset content.
|
|
3535
|
+
#
|
|
3536
|
+
# The following example creates a unique key for a CSV file:
|
|
3537
|
+
# `dataset/mydataset/!\{iotanalytics:scheduleTime\}/!\{iotanalytics:versionId\}.csv`
|
|
3538
|
+
#
|
|
3539
|
+
# <note markdown="1"> If you don't use `!\{iotanalytics:versionId\}` to specify the key,
|
|
3540
|
+
# you might get duplicate keys. For example, you might have two
|
|
3541
|
+
# dataset contents with the same `scheduleTime` but different
|
|
3542
|
+
# `versionId`s. This means that one dataset content overwrites the
|
|
3543
|
+
# other.
|
|
3544
|
+
#
|
|
3545
|
+
# </note>
|
|
3060
3546
|
# @return [String]
|
|
3061
3547
|
#
|
|
3062
3548
|
# @!attribute [rw] glue_configuration
|
|
3063
|
-
# Configuration information for coordination with
|
|
3064
|
-
#
|
|
3549
|
+
# Configuration information for coordination with AWS Glue, a fully
|
|
3550
|
+
# managed extract, transform and load (ETL) service.
|
|
3065
3551
|
# @return [Types::GlueConfiguration]
|
|
3066
3552
|
#
|
|
3067
3553
|
# @!attribute [rw] role_arn
|
|
3068
|
-
# The ARN of the role
|
|
3554
|
+
# The ARN of the role that grants AWS IoT Analytics permission to
|
|
3069
3555
|
# interact with your Amazon S3 and AWS Glue resources.
|
|
3070
3556
|
# @return [String]
|
|
3071
3557
|
#
|
|
@@ -3093,7 +3579,7 @@ module Aws::IoTAnalytics
|
|
|
3093
3579
|
# @return [String]
|
|
3094
3580
|
#
|
|
3095
3581
|
# @!attribute [rw] max_messages
|
|
3096
|
-
# The number of sample messages to be retrieved. The limit is 10
|
|
3582
|
+
# The number of sample messages to be retrieved. The limit is 10. The
|
|
3097
3583
|
# default is also 10.
|
|
3098
3584
|
# @return [Integer]
|
|
3099
3585
|
#
|
|
@@ -3137,8 +3623,8 @@ module Aws::IoTAnalytics
|
|
|
3137
3623
|
#
|
|
3138
3624
|
# @!attribute [rw] expression
|
|
3139
3625
|
# The expression that defines when to trigger an update. For more
|
|
3140
|
-
# information, see [
|
|
3141
|
-
# CloudWatch Events User Guide
|
|
3626
|
+
# information, see [Schedule Expressions for Rules][1] in the *Amazon
|
|
3627
|
+
# CloudWatch Events User Guide*.
|
|
3142
3628
|
#
|
|
3143
3629
|
#
|
|
3144
3630
|
#
|
|
@@ -3151,6 +3637,33 @@ module Aws::IoTAnalytics
|
|
|
3151
3637
|
include Aws::Structure
|
|
3152
3638
|
end
|
|
3153
3639
|
|
|
3640
|
+
# Information needed to define a schema.
|
|
3641
|
+
#
|
|
3642
|
+
# @note When making an API call, you may pass SchemaDefinition
|
|
3643
|
+
# data as a hash:
|
|
3644
|
+
#
|
|
3645
|
+
# {
|
|
3646
|
+
# columns: [
|
|
3647
|
+
# {
|
|
3648
|
+
# name: "ColumnName", # required
|
|
3649
|
+
# type: "ColumnDataType", # required
|
|
3650
|
+
# },
|
|
3651
|
+
# ],
|
|
3652
|
+
# }
|
|
3653
|
+
#
|
|
3654
|
+
# @!attribute [rw] columns
|
|
3655
|
+
# Specifies one or more columns that store your data.
|
|
3656
|
+
#
|
|
3657
|
+
# Each schema can have up to 100 columns. Each column can have up to
|
|
3658
|
+
# 100 nested types.
|
|
3659
|
+
# @return [Array<Types::Column>]
|
|
3660
|
+
#
|
|
3661
|
+
class SchemaDefinition < Struct.new(
|
|
3662
|
+
:columns)
|
|
3663
|
+
SENSITIVE = []
|
|
3664
|
+
include Aws::Structure
|
|
3665
|
+
end
|
|
3666
|
+
|
|
3154
3667
|
# Creates a new message using only the specified attributes from the
|
|
3155
3668
|
# original message.
|
|
3156
3669
|
#
|
|
@@ -3164,7 +3677,7 @@ module Aws::IoTAnalytics
|
|
|
3164
3677
|
# }
|
|
3165
3678
|
#
|
|
3166
3679
|
# @!attribute [rw] name
|
|
3167
|
-
# The name of the
|
|
3680
|
+
# The name of the `selectAttributes` activity.
|
|
3168
3681
|
# @return [String]
|
|
3169
3682
|
#
|
|
3170
3683
|
# @!attribute [rw] attributes
|
|
@@ -3183,30 +3696,29 @@ module Aws::IoTAnalytics
|
|
|
3183
3696
|
include Aws::Structure
|
|
3184
3697
|
end
|
|
3185
3698
|
|
|
3186
|
-
# Use this to store channel data in an S3 bucket managed by
|
|
3187
|
-
# Analytics
|
|
3188
|
-
# S3 storage
|
|
3699
|
+
# Use this to store channel data in an S3 bucket managed by AWS IoT
|
|
3700
|
+
# Analytics. You cannot change the choice of service-managed or
|
|
3701
|
+
# customer-managed S3 storage after the channel is created.
|
|
3189
3702
|
#
|
|
3190
3703
|
# @api private
|
|
3191
3704
|
#
|
|
3192
3705
|
class ServiceManagedChannelS3Storage < Aws::EmptyStructure; end
|
|
3193
3706
|
|
|
3194
|
-
# Used to store channel data in an S3 bucket managed by
|
|
3195
|
-
# Analytics
|
|
3707
|
+
# Used to store channel data in an S3 bucket managed by AWS IoT
|
|
3708
|
+
# Analytics.
|
|
3196
3709
|
#
|
|
3197
3710
|
class ServiceManagedChannelS3StorageSummary < Aws::EmptyStructure; end
|
|
3198
3711
|
|
|
3199
|
-
# Use this to store data store data in an S3 bucket managed by
|
|
3200
|
-
#
|
|
3201
|
-
# customer-managed S3 storage
|
|
3202
|
-
# data store.
|
|
3712
|
+
# Use this to store data store data in an S3 bucket managed by AWS IoT
|
|
3713
|
+
# Analytics. You cannot change the choice of service-managed or
|
|
3714
|
+
# customer-managed S3 storage after the data store is created.
|
|
3203
3715
|
#
|
|
3204
3716
|
# @api private
|
|
3205
3717
|
#
|
|
3206
3718
|
class ServiceManagedDatastoreS3Storage < Aws::EmptyStructure; end
|
|
3207
3719
|
|
|
3208
|
-
# Used to store data store data in an S3 bucket managed by
|
|
3209
|
-
# Analytics
|
|
3720
|
+
# Used to store data store data in an S3 bucket managed by AWS IoT
|
|
3721
|
+
# Analytics.
|
|
3210
3722
|
#
|
|
3211
3723
|
class ServiceManagedDatastoreS3StorageSummary < Aws::EmptyStructure; end
|
|
3212
3724
|
|
|
@@ -3243,7 +3755,7 @@ module Aws::IoTAnalytics
|
|
|
3243
3755
|
# @return [String]
|
|
3244
3756
|
#
|
|
3245
3757
|
# @!attribute [rw] filters
|
|
3246
|
-
#
|
|
3758
|
+
# Prefilters applied to message data.
|
|
3247
3759
|
# @return [Array<Types::QueryFilter>]
|
|
3248
3760
|
#
|
|
3249
3761
|
class SqlQueryDatasetAction < Struct.new(
|
|
@@ -3260,6 +3772,9 @@ module Aws::IoTAnalytics
|
|
|
3260
3772
|
# pipeline_name: "PipelineName", # required
|
|
3261
3773
|
# start_time: Time.now,
|
|
3262
3774
|
# end_time: Time.now,
|
|
3775
|
+
# channel_messages: {
|
|
3776
|
+
# s3_paths: ["S3PathChannelMessage"],
|
|
3777
|
+
# },
|
|
3263
3778
|
# }
|
|
3264
3779
|
#
|
|
3265
3780
|
# @!attribute [rw] pipeline_name
|
|
@@ -3268,16 +3783,31 @@ module Aws::IoTAnalytics
|
|
|
3268
3783
|
#
|
|
3269
3784
|
# @!attribute [rw] start_time
|
|
3270
3785
|
# The start time (inclusive) of raw message data that is reprocessed.
|
|
3786
|
+
#
|
|
3787
|
+
# If you specify a value for the `startTime` parameter, you must not
|
|
3788
|
+
# use the `channelMessages` object.
|
|
3271
3789
|
# @return [Time]
|
|
3272
3790
|
#
|
|
3273
3791
|
# @!attribute [rw] end_time
|
|
3274
3792
|
# The end time (exclusive) of raw message data that is reprocessed.
|
|
3793
|
+
#
|
|
3794
|
+
# If you specify a value for the `endTime` parameter, you must not use
|
|
3795
|
+
# the `channelMessages` object.
|
|
3275
3796
|
# @return [Time]
|
|
3276
3797
|
#
|
|
3798
|
+
# @!attribute [rw] channel_messages
|
|
3799
|
+
# Specifies one or more sets of channel messages that you want to
|
|
3800
|
+
# reprocess.
|
|
3801
|
+
#
|
|
3802
|
+
# If you use the `channelMessages` object, you must not specify a
|
|
3803
|
+
# value for `startTime` and `endTime`.
|
|
3804
|
+
# @return [Types::ChannelMessages]
|
|
3805
|
+
#
|
|
3277
3806
|
class StartPipelineReprocessingRequest < Struct.new(
|
|
3278
3807
|
:pipeline_name,
|
|
3279
3808
|
:start_time,
|
|
3280
|
-
:end_time
|
|
3809
|
+
:end_time,
|
|
3810
|
+
:channel_messages)
|
|
3281
3811
|
SENSITIVE = []
|
|
3282
3812
|
include Aws::Structure
|
|
3283
3813
|
end
|
|
@@ -3292,7 +3822,7 @@ module Aws::IoTAnalytics
|
|
|
3292
3822
|
include Aws::Structure
|
|
3293
3823
|
end
|
|
3294
3824
|
|
|
3295
|
-
# A set of key
|
|
3825
|
+
# A set of key-value pairs that are used to manage the resource.
|
|
3296
3826
|
#
|
|
3297
3827
|
# @note When making an API call, you may pass Tag
|
|
3298
3828
|
# data as a hash:
|
|
@@ -3358,8 +3888,33 @@ module Aws::IoTAnalytics
|
|
|
3358
3888
|
include Aws::Structure
|
|
3359
3889
|
end
|
|
3360
3890
|
|
|
3361
|
-
#
|
|
3362
|
-
#
|
|
3891
|
+
# A partition defined by a timestamp.
|
|
3892
|
+
#
|
|
3893
|
+
# @note When making an API call, you may pass TimestampPartition
|
|
3894
|
+
# data as a hash:
|
|
3895
|
+
#
|
|
3896
|
+
# {
|
|
3897
|
+
# attribute_name: "PartitionAttributeName", # required
|
|
3898
|
+
# timestamp_format: "TimestampFormat",
|
|
3899
|
+
# }
|
|
3900
|
+
#
|
|
3901
|
+
# @!attribute [rw] attribute_name
|
|
3902
|
+
# The attribute name of the partition defined by a timestamp.
|
|
3903
|
+
# @return [String]
|
|
3904
|
+
#
|
|
3905
|
+
# @!attribute [rw] timestamp_format
|
|
3906
|
+
# The timestamp format of a partition defined by a timestamp.
|
|
3907
|
+
# @return [String]
|
|
3908
|
+
#
|
|
3909
|
+
class TimestampPartition < Struct.new(
|
|
3910
|
+
:attribute_name,
|
|
3911
|
+
:timestamp_format)
|
|
3912
|
+
SENSITIVE = []
|
|
3913
|
+
include Aws::Structure
|
|
3914
|
+
end
|
|
3915
|
+
|
|
3916
|
+
# Information about the dataset whose content generation triggers the
|
|
3917
|
+
# new dataset content generation.
|
|
3363
3918
|
#
|
|
3364
3919
|
# @note When making an API call, you may pass TriggeringDataset
|
|
3365
3920
|
# data as a hash:
|
|
@@ -3369,8 +3924,8 @@ module Aws::IoTAnalytics
|
|
|
3369
3924
|
# }
|
|
3370
3925
|
#
|
|
3371
3926
|
# @!attribute [rw] name
|
|
3372
|
-
# The name of the
|
|
3373
|
-
#
|
|
3927
|
+
# The name of the dataset whose content generation triggers the new
|
|
3928
|
+
# dataset content generation.
|
|
3374
3929
|
# @return [String]
|
|
3375
3930
|
#
|
|
3376
3931
|
class TriggeringDataset < Struct.new(
|
|
@@ -3429,10 +3984,10 @@ module Aws::IoTAnalytics
|
|
|
3429
3984
|
# @return [String]
|
|
3430
3985
|
#
|
|
3431
3986
|
# @!attribute [rw] channel_storage
|
|
3432
|
-
# Where channel data is stored. You
|
|
3433
|
-
#
|
|
3434
|
-
#
|
|
3435
|
-
#
|
|
3987
|
+
# Where channel data is stored. You can choose one of
|
|
3988
|
+
# `serviceManagedS3` or `customerManagedS3` storage. If not specified,
|
|
3989
|
+
# the default is `serviceManagedS3`. You cannot change this storage
|
|
3990
|
+
# option after the channel is created.
|
|
3436
3991
|
# @return [Types::ChannelStorage]
|
|
3437
3992
|
#
|
|
3438
3993
|
# @!attribute [rw] retention_period
|
|
@@ -3529,6 +4084,16 @@ module Aws::IoTAnalytics
|
|
|
3529
4084
|
# unlimited: false,
|
|
3530
4085
|
# max_versions: 1,
|
|
3531
4086
|
# },
|
|
4087
|
+
# late_data_rules: [
|
|
4088
|
+
# {
|
|
4089
|
+
# rule_name: "LateDataRuleName",
|
|
4090
|
+
# rule_configuration: { # required
|
|
4091
|
+
# delta_time_session_window_configuration: {
|
|
4092
|
+
# timeout_in_minutes: 1, # required
|
|
4093
|
+
# },
|
|
4094
|
+
# },
|
|
4095
|
+
# },
|
|
4096
|
+
# ],
|
|
3532
4097
|
# }
|
|
3533
4098
|
#
|
|
3534
4099
|
# @!attribute [rw] dataset_name
|
|
@@ -3536,39 +4101,54 @@ module Aws::IoTAnalytics
|
|
|
3536
4101
|
# @return [String]
|
|
3537
4102
|
#
|
|
3538
4103
|
# @!attribute [rw] actions
|
|
3539
|
-
# A list of
|
|
4104
|
+
# A list of `DatasetAction` objects.
|
|
3540
4105
|
# @return [Array<Types::DatasetAction>]
|
|
3541
4106
|
#
|
|
3542
4107
|
# @!attribute [rw] triggers
|
|
3543
|
-
# A list of
|
|
3544
|
-
# contain up to five
|
|
4108
|
+
# A list of `DatasetTrigger` objects. The list can be empty or can
|
|
4109
|
+
# contain up to five `DatasetTrigger` objects.
|
|
3545
4110
|
# @return [Array<Types::DatasetTrigger>]
|
|
3546
4111
|
#
|
|
3547
4112
|
# @!attribute [rw] content_delivery_rules
|
|
3548
|
-
# When
|
|
4113
|
+
# When dataset contents are created, they are delivered to
|
|
3549
4114
|
# destinations specified here.
|
|
3550
4115
|
# @return [Array<Types::DatasetContentDeliveryRule>]
|
|
3551
4116
|
#
|
|
3552
4117
|
# @!attribute [rw] retention_period
|
|
3553
|
-
# How long, in days,
|
|
4118
|
+
# How long, in days, dataset contents are kept for the dataset.
|
|
3554
4119
|
# @return [Types::RetentionPeriod]
|
|
3555
4120
|
#
|
|
3556
4121
|
# @!attribute [rw] versioning_configuration
|
|
3557
|
-
#
|
|
4122
|
+
# Optional. How many versions of dataset contents are kept. If not
|
|
3558
4123
|
# specified or set to null, only the latest version plus the latest
|
|
3559
4124
|
# succeeded version (if they are different) are kept for the time
|
|
3560
|
-
# period specified by the
|
|
3561
|
-
# information, see
|
|
3562
|
-
#
|
|
4125
|
+
# period specified by the `retentionPeriod` parameter. For more
|
|
4126
|
+
# information, see [Keeping Multiple Versions of AWS IoT Analytics
|
|
4127
|
+
# Data Sets][1] in the *AWS IoT Analytics User Guide*.
|
|
4128
|
+
#
|
|
4129
|
+
#
|
|
4130
|
+
#
|
|
4131
|
+
# [1]: https://docs.aws.amazon.com/iotanalytics/latest/userguide/getting-started.html#aws-iot-analytics-dataset-versions
|
|
3563
4132
|
# @return [Types::VersioningConfiguration]
|
|
3564
4133
|
#
|
|
4134
|
+
# @!attribute [rw] late_data_rules
|
|
4135
|
+
# A list of data rules that send notifications to Amazon CloudWatch,
|
|
4136
|
+
# when data arrives late. To specify `lateDataRules`, the dataset must
|
|
4137
|
+
# use a [DeltaTimer][1] filter.
|
|
4138
|
+
#
|
|
4139
|
+
#
|
|
4140
|
+
#
|
|
4141
|
+
# [1]: https://docs.aws.amazon.com/iotanalytics/latest/APIReference/API_DeltaTime.html
|
|
4142
|
+
# @return [Array<Types::LateDataRule>]
|
|
4143
|
+
#
|
|
3565
4144
|
class UpdateDatasetRequest < Struct.new(
|
|
3566
4145
|
:dataset_name,
|
|
3567
4146
|
:actions,
|
|
3568
4147
|
:triggers,
|
|
3569
4148
|
:content_delivery_rules,
|
|
3570
4149
|
:retention_period,
|
|
3571
|
-
:versioning_configuration
|
|
4150
|
+
:versioning_configuration,
|
|
4151
|
+
:late_data_rules)
|
|
3572
4152
|
SENSITIVE = []
|
|
3573
4153
|
include Aws::Structure
|
|
3574
4154
|
end
|
|
@@ -3591,6 +4171,20 @@ module Aws::IoTAnalytics
|
|
|
3591
4171
|
# role_arn: "RoleArn", # required
|
|
3592
4172
|
# },
|
|
3593
4173
|
# },
|
|
4174
|
+
# file_format_configuration: {
|
|
4175
|
+
# json_configuration: {
|
|
4176
|
+
# },
|
|
4177
|
+
# parquet_configuration: {
|
|
4178
|
+
# schema_definition: {
|
|
4179
|
+
# columns: [
|
|
4180
|
+
# {
|
|
4181
|
+
# name: "ColumnName", # required
|
|
4182
|
+
# type: "ColumnDataType", # required
|
|
4183
|
+
# },
|
|
4184
|
+
# ],
|
|
4185
|
+
# },
|
|
4186
|
+
# },
|
|
4187
|
+
# },
|
|
3594
4188
|
# }
|
|
3595
4189
|
#
|
|
3596
4190
|
# @!attribute [rw] datastore_name
|
|
@@ -3604,16 +4198,30 @@ module Aws::IoTAnalytics
|
|
|
3604
4198
|
# @return [Types::RetentionPeriod]
|
|
3605
4199
|
#
|
|
3606
4200
|
# @!attribute [rw] datastore_storage
|
|
3607
|
-
# Where data store data is stored. You
|
|
3608
|
-
#
|
|
3609
|
-
#
|
|
3610
|
-
#
|
|
4201
|
+
# Where data store data is stored. You can choose one of
|
|
4202
|
+
# `serviceManagedS3` or `customerManagedS3` storage. If not specified,
|
|
4203
|
+
# the default is`serviceManagedS3`. You cannot change this storage
|
|
4204
|
+
# option after the data store is created.
|
|
3611
4205
|
# @return [Types::DatastoreStorage]
|
|
3612
4206
|
#
|
|
4207
|
+
# @!attribute [rw] file_format_configuration
|
|
4208
|
+
# Contains the configuration information of file formats. AWS IoT
|
|
4209
|
+
# Analytics data stores support JSON and [Parquet][1].
|
|
4210
|
+
#
|
|
4211
|
+
# The default file format is JSON. You can specify only one format.
|
|
4212
|
+
#
|
|
4213
|
+
# You can't change the file format after you create the data store.
|
|
4214
|
+
#
|
|
4215
|
+
#
|
|
4216
|
+
#
|
|
4217
|
+
# [1]: https://parquet.apache.org/
|
|
4218
|
+
# @return [Types::FileFormatConfiguration]
|
|
4219
|
+
#
|
|
3613
4220
|
class UpdateDatastoreRequest < Struct.new(
|
|
3614
4221
|
:datastore_name,
|
|
3615
4222
|
:retention_period,
|
|
3616
|
-
:datastore_storage
|
|
4223
|
+
:datastore_storage,
|
|
4224
|
+
:file_format_configuration)
|
|
3617
4225
|
SENSITIVE = []
|
|
3618
4226
|
include Aws::Structure
|
|
3619
4227
|
end
|
|
@@ -3691,16 +4299,16 @@ module Aws::IoTAnalytics
|
|
|
3691
4299
|
# @return [String]
|
|
3692
4300
|
#
|
|
3693
4301
|
# @!attribute [rw] pipeline_activities
|
|
3694
|
-
# A list of
|
|
4302
|
+
# A list of `PipelineActivity` objects. Activities perform
|
|
3695
4303
|
# transformations on your messages, such as removing, renaming or
|
|
3696
4304
|
# adding message attributes; filtering messages based on attribute
|
|
3697
4305
|
# values; invoking your Lambda functions on messages for advanced
|
|
3698
4306
|
# processing; or performing mathematical transformations to normalize
|
|
3699
4307
|
# device data.
|
|
3700
4308
|
#
|
|
3701
|
-
# The list can be 2-25
|
|
4309
|
+
# The list can be 2-25 `PipelineActivity` objects and must contain
|
|
3702
4310
|
# both a `channel` and a `datastore` activity. Each entry in the list
|
|
3703
|
-
# must contain only one activity
|
|
4311
|
+
# must contain only one activity. For example:
|
|
3704
4312
|
#
|
|
3705
4313
|
# `pipelineActivities = [ \{ "channel": \{ ... \} \}, \{ "lambda": \{
|
|
3706
4314
|
# ... \} \}, ... ]`
|
|
@@ -3713,10 +4321,9 @@ module Aws::IoTAnalytics
|
|
|
3713
4321
|
include Aws::Structure
|
|
3714
4322
|
end
|
|
3715
4323
|
|
|
3716
|
-
# An instance of a variable to be passed to the
|
|
4324
|
+
# An instance of a variable to be passed to the `containerAction`
|
|
3717
4325
|
# execution. Each variable must have a name and a value given by one of
|
|
3718
|
-
#
|
|
3719
|
-
# "outputFileUriValue".
|
|
4326
|
+
# `stringValue`, `datasetContentVersionValue`, or `outputFileUriValue`.
|
|
3720
4327
|
#
|
|
3721
4328
|
# @note When making an API call, you may pass Variable
|
|
3722
4329
|
# data as a hash:
|
|
@@ -3746,7 +4353,7 @@ module Aws::IoTAnalytics
|
|
|
3746
4353
|
# @return [Float]
|
|
3747
4354
|
#
|
|
3748
4355
|
# @!attribute [rw] dataset_content_version_value
|
|
3749
|
-
# The value of the variable as a structure that specifies a
|
|
4356
|
+
# The value of the variable as a structure that specifies a dataset
|
|
3750
4357
|
# content version.
|
|
3751
4358
|
# @return [Types::DatasetContentVersionValue]
|
|
3752
4359
|
#
|
|
@@ -3765,7 +4372,7 @@ module Aws::IoTAnalytics
|
|
|
3765
4372
|
include Aws::Structure
|
|
3766
4373
|
end
|
|
3767
4374
|
|
|
3768
|
-
# Information about the versioning of
|
|
4375
|
+
# Information about the versioning of dataset contents.
|
|
3769
4376
|
#
|
|
3770
4377
|
# @note When making an API call, you may pass VersioningConfiguration
|
|
3771
4378
|
# data as a hash:
|
|
@@ -3776,12 +4383,12 @@ module Aws::IoTAnalytics
|
|
|
3776
4383
|
# }
|
|
3777
4384
|
#
|
|
3778
4385
|
# @!attribute [rw] unlimited
|
|
3779
|
-
# If true, unlimited versions of
|
|
4386
|
+
# If true, unlimited versions of dataset contents are kept.
|
|
3780
4387
|
# @return [Boolean]
|
|
3781
4388
|
#
|
|
3782
4389
|
# @!attribute [rw] max_versions
|
|
3783
|
-
# How many versions of
|
|
3784
|
-
#
|
|
4390
|
+
# How many versions of dataset contents are kept. The `unlimited`
|
|
4391
|
+
# parameter must be `false`.
|
|
3785
4392
|
# @return [Integer]
|
|
3786
4393
|
#
|
|
3787
4394
|
class VersioningConfiguration < Struct.new(
|