aws-sdk-iotanalytics 1.32.0 → 1.37.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-iotanalytics.rb +2 -1
- data/lib/aws-sdk-iotanalytics/client.rb +227 -89
- data/lib/aws-sdk-iotanalytics/client_api.rb +66 -0
- data/lib/aws-sdk-iotanalytics/types.rb +790 -319
- metadata +4 -4
@@ -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')
|
@@ -94,6 +99,7 @@ module Aws::IoTAnalytics
|
|
94
99
|
DeleteDatastoreRequest = Shapes::StructureShape.new(name: 'DeleteDatastoreRequest')
|
95
100
|
DeletePipelineRequest = Shapes::StructureShape.new(name: 'DeletePipelineRequest')
|
96
101
|
DeltaTime = Shapes::StructureShape.new(name: 'DeltaTime')
|
102
|
+
DeltaTimeSessionWindowConfiguration = Shapes::StructureShape.new(name: 'DeltaTimeSessionWindowConfiguration')
|
97
103
|
DescribeChannelRequest = Shapes::StructureShape.new(name: 'DescribeChannelRequest')
|
98
104
|
DescribeChannelResponse = Shapes::StructureShape.new(name: 'DescribeChannelResponse')
|
99
105
|
DescribeDatasetRequest = Shapes::StructureShape.new(name: 'DescribeDatasetRequest')
|
@@ -112,6 +118,8 @@ module Aws::IoTAnalytics
|
|
112
118
|
ErrorCode = Shapes::StringShape.new(name: 'ErrorCode')
|
113
119
|
ErrorMessage = Shapes::StringShape.new(name: 'ErrorMessage')
|
114
120
|
EstimatedResourceSize = Shapes::StructureShape.new(name: 'EstimatedResourceSize')
|
121
|
+
FileFormatConfiguration = Shapes::StructureShape.new(name: 'FileFormatConfiguration')
|
122
|
+
FileFormatType = Shapes::StringShape.new(name: 'FileFormatType')
|
115
123
|
FilterActivity = Shapes::StructureShape.new(name: 'FilterActivity')
|
116
124
|
FilterExpression = Shapes::StringShape.new(name: 'FilterExpression')
|
117
125
|
GetDatasetContentRequest = Shapes::StructureShape.new(name: 'GetDatasetContentRequest')
|
@@ -125,8 +133,13 @@ module Aws::IoTAnalytics
|
|
125
133
|
InvalidRequestException = Shapes::StructureShape.new(name: 'InvalidRequestException')
|
126
134
|
IotEventsDestinationConfiguration = Shapes::StructureShape.new(name: 'IotEventsDestinationConfiguration')
|
127
135
|
IotEventsInputName = Shapes::StringShape.new(name: 'IotEventsInputName')
|
136
|
+
JsonConfiguration = Shapes::StructureShape.new(name: 'JsonConfiguration')
|
128
137
|
LambdaActivity = Shapes::StructureShape.new(name: 'LambdaActivity')
|
129
138
|
LambdaName = Shapes::StringShape.new(name: 'LambdaName')
|
139
|
+
LateDataRule = Shapes::StructureShape.new(name: 'LateDataRule')
|
140
|
+
LateDataRuleConfiguration = Shapes::StructureShape.new(name: 'LateDataRuleConfiguration')
|
141
|
+
LateDataRuleName = Shapes::StringShape.new(name: 'LateDataRuleName')
|
142
|
+
LateDataRules = Shapes::ListShape.new(name: 'LateDataRules')
|
130
143
|
LimitExceededException = Shapes::StructureShape.new(name: 'LimitExceededException')
|
131
144
|
ListChannelsRequest = Shapes::StructureShape.new(name: 'ListChannelsRequest')
|
132
145
|
ListChannelsResponse = Shapes::StructureShape.new(name: 'ListChannelsResponse')
|
@@ -158,6 +171,7 @@ module Aws::IoTAnalytics
|
|
158
171
|
OffsetSeconds = Shapes::IntegerShape.new(name: 'OffsetSeconds')
|
159
172
|
OutputFileName = Shapes::StringShape.new(name: 'OutputFileName')
|
160
173
|
OutputFileUriValue = Shapes::StructureShape.new(name: 'OutputFileUriValue')
|
174
|
+
ParquetConfiguration = Shapes::StructureShape.new(name: 'ParquetConfiguration')
|
161
175
|
Pipeline = Shapes::StructureShape.new(name: 'Pipeline')
|
162
176
|
PipelineActivities = Shapes::ListShape.new(name: 'PipelineActivities')
|
163
177
|
PipelineActivity = Shapes::StructureShape.new(name: 'PipelineActivity')
|
@@ -186,16 +200,20 @@ module Aws::IoTAnalytics
|
|
186
200
|
RunPipelineActivityResponse = Shapes::StructureShape.new(name: 'RunPipelineActivityResponse')
|
187
201
|
S3DestinationConfiguration = Shapes::StructureShape.new(name: 'S3DestinationConfiguration')
|
188
202
|
S3KeyPrefix = Shapes::StringShape.new(name: 'S3KeyPrefix')
|
203
|
+
S3PathChannelMessage = Shapes::StringShape.new(name: 'S3PathChannelMessage')
|
204
|
+
S3PathChannelMessages = Shapes::ListShape.new(name: 'S3PathChannelMessages')
|
189
205
|
SampleChannelDataRequest = Shapes::StructureShape.new(name: 'SampleChannelDataRequest')
|
190
206
|
SampleChannelDataResponse = Shapes::StructureShape.new(name: 'SampleChannelDataResponse')
|
191
207
|
Schedule = Shapes::StructureShape.new(name: 'Schedule')
|
192
208
|
ScheduleExpression = Shapes::StringShape.new(name: 'ScheduleExpression')
|
209
|
+
SchemaDefinition = Shapes::StructureShape.new(name: 'SchemaDefinition')
|
193
210
|
SelectAttributesActivity = Shapes::StructureShape.new(name: 'SelectAttributesActivity')
|
194
211
|
ServiceManagedChannelS3Storage = Shapes::StructureShape.new(name: 'ServiceManagedChannelS3Storage')
|
195
212
|
ServiceManagedChannelS3StorageSummary = Shapes::StructureShape.new(name: 'ServiceManagedChannelS3StorageSummary')
|
196
213
|
ServiceManagedDatastoreS3Storage = Shapes::StructureShape.new(name: 'ServiceManagedDatastoreS3Storage')
|
197
214
|
ServiceManagedDatastoreS3StorageSummary = Shapes::StructureShape.new(name: 'ServiceManagedDatastoreS3StorageSummary')
|
198
215
|
ServiceUnavailableException = Shapes::StructureShape.new(name: 'ServiceUnavailableException')
|
216
|
+
SessionTimeoutInMinutes = Shapes::IntegerShape.new(name: 'SessionTimeoutInMinutes')
|
199
217
|
SizeInBytes = Shapes::FloatShape.new(name: 'SizeInBytes')
|
200
218
|
SqlQuery = Shapes::StringShape.new(name: 'SqlQuery')
|
201
219
|
SqlQueryDatasetAction = Shapes::StructureShape.new(name: 'SqlQueryDatasetAction')
|
@@ -268,6 +286,7 @@ module Aws::IoTAnalytics
|
|
268
286
|
Channel.add_member(:retention_period, Shapes::ShapeRef.new(shape: RetentionPeriod, location_name: "retentionPeriod"))
|
269
287
|
Channel.add_member(:creation_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "creationTime"))
|
270
288
|
Channel.add_member(:last_update_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "lastUpdateTime"))
|
289
|
+
Channel.add_member(:last_message_arrival_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "lastMessageArrivalTime"))
|
271
290
|
Channel.struct_class = Types::Channel
|
272
291
|
|
273
292
|
ChannelActivity.add_member(:name, Shapes::ShapeRef.new(shape: ActivityName, required: true, location_name: "name"))
|
@@ -275,6 +294,9 @@ module Aws::IoTAnalytics
|
|
275
294
|
ChannelActivity.add_member(:next, Shapes::ShapeRef.new(shape: ActivityName, location_name: "next"))
|
276
295
|
ChannelActivity.struct_class = Types::ChannelActivity
|
277
296
|
|
297
|
+
ChannelMessages.add_member(:s3_paths, Shapes::ShapeRef.new(shape: S3PathChannelMessages, location_name: "s3Paths"))
|
298
|
+
ChannelMessages.struct_class = Types::ChannelMessages
|
299
|
+
|
278
300
|
ChannelStatistics.add_member(:size, Shapes::ShapeRef.new(shape: EstimatedResourceSize, location_name: "size"))
|
279
301
|
ChannelStatistics.struct_class = Types::ChannelStatistics
|
280
302
|
|
@@ -293,8 +315,15 @@ module Aws::IoTAnalytics
|
|
293
315
|
ChannelSummary.add_member(:status, Shapes::ShapeRef.new(shape: ChannelStatus, location_name: "status"))
|
294
316
|
ChannelSummary.add_member(:creation_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "creationTime"))
|
295
317
|
ChannelSummary.add_member(:last_update_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "lastUpdateTime"))
|
318
|
+
ChannelSummary.add_member(:last_message_arrival_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "lastMessageArrivalTime"))
|
296
319
|
ChannelSummary.struct_class = Types::ChannelSummary
|
297
320
|
|
321
|
+
Column.add_member(:name, Shapes::ShapeRef.new(shape: ColumnName, required: true, location_name: "name"))
|
322
|
+
Column.add_member(:type, Shapes::ShapeRef.new(shape: ColumnDataType, required: true, location_name: "type"))
|
323
|
+
Column.struct_class = Types::Column
|
324
|
+
|
325
|
+
Columns.member = Shapes::ShapeRef.new(shape: Column)
|
326
|
+
|
298
327
|
ContainerDatasetAction.add_member(:image, Shapes::ShapeRef.new(shape: Image, required: true, location_name: "image"))
|
299
328
|
ContainerDatasetAction.add_member(:execution_role_arn, Shapes::ShapeRef.new(shape: RoleArn, required: true, location_name: "executionRoleArn"))
|
300
329
|
ContainerDatasetAction.add_member(:resource_configuration, Shapes::ShapeRef.new(shape: ResourceConfiguration, required: true, location_name: "resourceConfiguration"))
|
@@ -313,6 +342,7 @@ module Aws::IoTAnalytics
|
|
313
342
|
CreateChannelResponse.struct_class = Types::CreateChannelResponse
|
314
343
|
|
315
344
|
CreateDatasetContentRequest.add_member(:dataset_name, Shapes::ShapeRef.new(shape: DatasetName, required: true, location: "uri", location_name: "datasetName"))
|
345
|
+
CreateDatasetContentRequest.add_member(:version_id, Shapes::ShapeRef.new(shape: DatasetContentVersion, location_name: "versionId"))
|
316
346
|
CreateDatasetContentRequest.struct_class = Types::CreateDatasetContentRequest
|
317
347
|
|
318
348
|
CreateDatasetContentResponse.add_member(:version_id, Shapes::ShapeRef.new(shape: DatasetContentVersion, location_name: "versionId"))
|
@@ -325,6 +355,7 @@ module Aws::IoTAnalytics
|
|
325
355
|
CreateDatasetRequest.add_member(:retention_period, Shapes::ShapeRef.new(shape: RetentionPeriod, location_name: "retentionPeriod"))
|
326
356
|
CreateDatasetRequest.add_member(:versioning_configuration, Shapes::ShapeRef.new(shape: VersioningConfiguration, location_name: "versioningConfiguration"))
|
327
357
|
CreateDatasetRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "tags"))
|
358
|
+
CreateDatasetRequest.add_member(:late_data_rules, Shapes::ShapeRef.new(shape: LateDataRules, location_name: "lateDataRules"))
|
328
359
|
CreateDatasetRequest.struct_class = Types::CreateDatasetRequest
|
329
360
|
|
330
361
|
CreateDatasetResponse.add_member(:dataset_name, Shapes::ShapeRef.new(shape: DatasetName, location_name: "datasetName"))
|
@@ -336,6 +367,7 @@ module Aws::IoTAnalytics
|
|
336
367
|
CreateDatastoreRequest.add_member(:datastore_storage, Shapes::ShapeRef.new(shape: DatastoreStorage, location_name: "datastoreStorage"))
|
337
368
|
CreateDatastoreRequest.add_member(:retention_period, Shapes::ShapeRef.new(shape: RetentionPeriod, location_name: "retentionPeriod"))
|
338
369
|
CreateDatastoreRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "tags"))
|
370
|
+
CreateDatastoreRequest.add_member(:file_format_configuration, Shapes::ShapeRef.new(shape: FileFormatConfiguration, location_name: "fileFormatConfiguration"))
|
339
371
|
CreateDatastoreRequest.struct_class = Types::CreateDatastoreRequest
|
340
372
|
|
341
373
|
CreateDatastoreResponse.add_member(:datastore_name, Shapes::ShapeRef.new(shape: DatastoreName, location_name: "datastoreName"))
|
@@ -382,6 +414,7 @@ module Aws::IoTAnalytics
|
|
382
414
|
Dataset.add_member(:last_update_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "lastUpdateTime"))
|
383
415
|
Dataset.add_member(:retention_period, Shapes::ShapeRef.new(shape: RetentionPeriod, location_name: "retentionPeriod"))
|
384
416
|
Dataset.add_member(:versioning_configuration, Shapes::ShapeRef.new(shape: VersioningConfiguration, location_name: "versioningConfiguration"))
|
417
|
+
Dataset.add_member(:late_data_rules, Shapes::ShapeRef.new(shape: LateDataRules, location_name: "lateDataRules"))
|
385
418
|
Dataset.struct_class = Types::Dataset
|
386
419
|
|
387
420
|
DatasetAction.add_member(:action_name, Shapes::ShapeRef.new(shape: DatasetActionName, location_name: "actionName"))
|
@@ -452,6 +485,8 @@ module Aws::IoTAnalytics
|
|
452
485
|
Datastore.add_member(:retention_period, Shapes::ShapeRef.new(shape: RetentionPeriod, location_name: "retentionPeriod"))
|
453
486
|
Datastore.add_member(:creation_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "creationTime"))
|
454
487
|
Datastore.add_member(:last_update_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "lastUpdateTime"))
|
488
|
+
Datastore.add_member(:last_message_arrival_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "lastMessageArrivalTime"))
|
489
|
+
Datastore.add_member(:file_format_configuration, Shapes::ShapeRef.new(shape: FileFormatConfiguration, location_name: "fileFormatConfiguration"))
|
455
490
|
Datastore.struct_class = Types::Datastore
|
456
491
|
|
457
492
|
DatastoreActivity.add_member(:name, Shapes::ShapeRef.new(shape: ActivityName, required: true, location_name: "name"))
|
@@ -476,6 +511,8 @@ module Aws::IoTAnalytics
|
|
476
511
|
DatastoreSummary.add_member(:status, Shapes::ShapeRef.new(shape: DatastoreStatus, location_name: "status"))
|
477
512
|
DatastoreSummary.add_member(:creation_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "creationTime"))
|
478
513
|
DatastoreSummary.add_member(:last_update_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "lastUpdateTime"))
|
514
|
+
DatastoreSummary.add_member(:last_message_arrival_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "lastMessageArrivalTime"))
|
515
|
+
DatastoreSummary.add_member(:file_format_type, Shapes::ShapeRef.new(shape: FileFormatType, location_name: "fileFormatType"))
|
479
516
|
DatastoreSummary.struct_class = Types::DatastoreSummary
|
480
517
|
|
481
518
|
DeleteChannelRequest.add_member(:channel_name, Shapes::ShapeRef.new(shape: ChannelName, required: true, location: "uri", location_name: "channelName"))
|
@@ -498,6 +535,9 @@ module Aws::IoTAnalytics
|
|
498
535
|
DeltaTime.add_member(:time_expression, Shapes::ShapeRef.new(shape: TimeExpression, required: true, location_name: "timeExpression"))
|
499
536
|
DeltaTime.struct_class = Types::DeltaTime
|
500
537
|
|
538
|
+
DeltaTimeSessionWindowConfiguration.add_member(:timeout_in_minutes, Shapes::ShapeRef.new(shape: SessionTimeoutInMinutes, required: true, location_name: "timeoutInMinutes"))
|
539
|
+
DeltaTimeSessionWindowConfiguration.struct_class = Types::DeltaTimeSessionWindowConfiguration
|
540
|
+
|
501
541
|
DescribeChannelRequest.add_member(:channel_name, Shapes::ShapeRef.new(shape: ChannelName, required: true, location: "uri", location_name: "channelName"))
|
502
542
|
DescribeChannelRequest.add_member(:include_statistics, Shapes::ShapeRef.new(shape: IncludeStatisticsFlag, location: "querystring", location_name: "includeStatistics"))
|
503
543
|
DescribeChannelRequest.struct_class = Types::DescribeChannelRequest
|
@@ -549,6 +589,10 @@ module Aws::IoTAnalytics
|
|
549
589
|
EstimatedResourceSize.add_member(:estimated_on, Shapes::ShapeRef.new(shape: Timestamp, location_name: "estimatedOn"))
|
550
590
|
EstimatedResourceSize.struct_class = Types::EstimatedResourceSize
|
551
591
|
|
592
|
+
FileFormatConfiguration.add_member(:json_configuration, Shapes::ShapeRef.new(shape: JsonConfiguration, location_name: "jsonConfiguration"))
|
593
|
+
FileFormatConfiguration.add_member(:parquet_configuration, Shapes::ShapeRef.new(shape: ParquetConfiguration, location_name: "parquetConfiguration"))
|
594
|
+
FileFormatConfiguration.struct_class = Types::FileFormatConfiguration
|
595
|
+
|
552
596
|
FilterActivity.add_member(:name, Shapes::ShapeRef.new(shape: ActivityName, required: true, location_name: "name"))
|
553
597
|
FilterActivity.add_member(:filter, Shapes::ShapeRef.new(shape: FilterExpression, required: true, location_name: "filter"))
|
554
598
|
FilterActivity.add_member(:next, Shapes::ShapeRef.new(shape: ActivityName, location_name: "next"))
|
@@ -577,12 +621,23 @@ module Aws::IoTAnalytics
|
|
577
621
|
IotEventsDestinationConfiguration.add_member(:role_arn, Shapes::ShapeRef.new(shape: RoleArn, required: true, location_name: "roleArn"))
|
578
622
|
IotEventsDestinationConfiguration.struct_class = Types::IotEventsDestinationConfiguration
|
579
623
|
|
624
|
+
JsonConfiguration.struct_class = Types::JsonConfiguration
|
625
|
+
|
580
626
|
LambdaActivity.add_member(:name, Shapes::ShapeRef.new(shape: ActivityName, required: true, location_name: "name"))
|
581
627
|
LambdaActivity.add_member(:lambda_name, Shapes::ShapeRef.new(shape: LambdaName, required: true, location_name: "lambdaName"))
|
582
628
|
LambdaActivity.add_member(:batch_size, Shapes::ShapeRef.new(shape: ActivityBatchSize, required: true, location_name: "batchSize"))
|
583
629
|
LambdaActivity.add_member(:next, Shapes::ShapeRef.new(shape: ActivityName, location_name: "next"))
|
584
630
|
LambdaActivity.struct_class = Types::LambdaActivity
|
585
631
|
|
632
|
+
LateDataRule.add_member(:rule_name, Shapes::ShapeRef.new(shape: LateDataRuleName, location_name: "ruleName"))
|
633
|
+
LateDataRule.add_member(:rule_configuration, Shapes::ShapeRef.new(shape: LateDataRuleConfiguration, required: true, location_name: "ruleConfiguration"))
|
634
|
+
LateDataRule.struct_class = Types::LateDataRule
|
635
|
+
|
636
|
+
LateDataRuleConfiguration.add_member(:delta_time_session_window_configuration, Shapes::ShapeRef.new(shape: DeltaTimeSessionWindowConfiguration, location_name: "deltaTimeSessionWindowConfiguration"))
|
637
|
+
LateDataRuleConfiguration.struct_class = Types::LateDataRuleConfiguration
|
638
|
+
|
639
|
+
LateDataRules.member = Shapes::ShapeRef.new(shape: LateDataRule)
|
640
|
+
|
586
641
|
LimitExceededException.add_member(:message, Shapes::ShapeRef.new(shape: errorMessage, location_name: "message"))
|
587
642
|
LimitExceededException.struct_class = Types::LimitExceededException
|
588
643
|
|
@@ -657,6 +712,9 @@ module Aws::IoTAnalytics
|
|
657
712
|
OutputFileUriValue.add_member(:file_name, Shapes::ShapeRef.new(shape: OutputFileName, required: true, location_name: "fileName"))
|
658
713
|
OutputFileUriValue.struct_class = Types::OutputFileUriValue
|
659
714
|
|
715
|
+
ParquetConfiguration.add_member(:schema_definition, Shapes::ShapeRef.new(shape: SchemaDefinition, location_name: "schemaDefinition"))
|
716
|
+
ParquetConfiguration.struct_class = Types::ParquetConfiguration
|
717
|
+
|
660
718
|
Pipeline.add_member(:name, Shapes::ShapeRef.new(shape: PipelineName, location_name: "name"))
|
661
719
|
Pipeline.add_member(:arn, Shapes::ShapeRef.new(shape: PipelineArn, location_name: "arn"))
|
662
720
|
Pipeline.add_member(:activities, Shapes::ShapeRef.new(shape: PipelineActivities, location_name: "activities"))
|
@@ -737,6 +795,8 @@ module Aws::IoTAnalytics
|
|
737
795
|
S3DestinationConfiguration.add_member(:role_arn, Shapes::ShapeRef.new(shape: RoleArn, required: true, location_name: "roleArn"))
|
738
796
|
S3DestinationConfiguration.struct_class = Types::S3DestinationConfiguration
|
739
797
|
|
798
|
+
S3PathChannelMessages.member = Shapes::ShapeRef.new(shape: S3PathChannelMessage)
|
799
|
+
|
740
800
|
SampleChannelDataRequest.add_member(:channel_name, Shapes::ShapeRef.new(shape: ChannelName, required: true, location: "uri", location_name: "channelName"))
|
741
801
|
SampleChannelDataRequest.add_member(:max_messages, Shapes::ShapeRef.new(shape: MaxMessages, location: "querystring", location_name: "maxMessages"))
|
742
802
|
SampleChannelDataRequest.add_member(:start_time, Shapes::ShapeRef.new(shape: StartTime, location: "querystring", location_name: "startTime"))
|
@@ -749,6 +809,9 @@ module Aws::IoTAnalytics
|
|
749
809
|
Schedule.add_member(:expression, Shapes::ShapeRef.new(shape: ScheduleExpression, location_name: "expression"))
|
750
810
|
Schedule.struct_class = Types::Schedule
|
751
811
|
|
812
|
+
SchemaDefinition.add_member(:columns, Shapes::ShapeRef.new(shape: Columns, location_name: "columns"))
|
813
|
+
SchemaDefinition.struct_class = Types::SchemaDefinition
|
814
|
+
|
752
815
|
SelectAttributesActivity.add_member(:name, Shapes::ShapeRef.new(shape: ActivityName, required: true, location_name: "name"))
|
753
816
|
SelectAttributesActivity.add_member(:attributes, Shapes::ShapeRef.new(shape: AttributeNames, required: true, location_name: "attributes"))
|
754
817
|
SelectAttributesActivity.add_member(:next, Shapes::ShapeRef.new(shape: ActivityName, location_name: "next"))
|
@@ -772,6 +835,7 @@ module Aws::IoTAnalytics
|
|
772
835
|
StartPipelineReprocessingRequest.add_member(:pipeline_name, Shapes::ShapeRef.new(shape: PipelineName, required: true, location: "uri", location_name: "pipelineName"))
|
773
836
|
StartPipelineReprocessingRequest.add_member(:start_time, Shapes::ShapeRef.new(shape: StartTime, location_name: "startTime"))
|
774
837
|
StartPipelineReprocessingRequest.add_member(:end_time, Shapes::ShapeRef.new(shape: EndTime, location_name: "endTime"))
|
838
|
+
StartPipelineReprocessingRequest.add_member(:channel_messages, Shapes::ShapeRef.new(shape: ChannelMessages, location_name: "channelMessages"))
|
775
839
|
StartPipelineReprocessingRequest.struct_class = Types::StartPipelineReprocessingRequest
|
776
840
|
|
777
841
|
StartPipelineReprocessingResponse.add_member(:reprocessing_id, Shapes::ShapeRef.new(shape: ReprocessingId, location_name: "reprocessingId"))
|
@@ -814,11 +878,13 @@ module Aws::IoTAnalytics
|
|
814
878
|
UpdateDatasetRequest.add_member(:content_delivery_rules, Shapes::ShapeRef.new(shape: DatasetContentDeliveryRules, location_name: "contentDeliveryRules"))
|
815
879
|
UpdateDatasetRequest.add_member(:retention_period, Shapes::ShapeRef.new(shape: RetentionPeriod, location_name: "retentionPeriod"))
|
816
880
|
UpdateDatasetRequest.add_member(:versioning_configuration, Shapes::ShapeRef.new(shape: VersioningConfiguration, location_name: "versioningConfiguration"))
|
881
|
+
UpdateDatasetRequest.add_member(:late_data_rules, Shapes::ShapeRef.new(shape: LateDataRules, location_name: "lateDataRules"))
|
817
882
|
UpdateDatasetRequest.struct_class = Types::UpdateDatasetRequest
|
818
883
|
|
819
884
|
UpdateDatastoreRequest.add_member(:datastore_name, Shapes::ShapeRef.new(shape: DatastoreName, required: true, location: "uri", location_name: "datastoreName"))
|
820
885
|
UpdateDatastoreRequest.add_member(:retention_period, Shapes::ShapeRef.new(shape: RetentionPeriod, location_name: "retentionPeriod"))
|
821
886
|
UpdateDatastoreRequest.add_member(:datastore_storage, Shapes::ShapeRef.new(shape: DatastoreStorage, location_name: "datastoreStorage"))
|
887
|
+
UpdateDatastoreRequest.add_member(:file_format_configuration, Shapes::ShapeRef.new(shape: FileFormatConfiguration, location_name: "fileFormatConfiguration"))
|
822
888
|
UpdateDatastoreRequest.struct_class = Types::UpdateDatastoreRequest
|
823
889
|
|
824
890
|
UpdatePipelineRequest.add_member(:pipeline_name, Shapes::ShapeRef.new(shape: PipelineName, required: true, location: "uri", location_name: "pipelineName"))
|
@@ -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,26 @@ 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
|
+
# @return [Array<String>]
|
267
|
+
#
|
268
|
+
class ChannelMessages < Struct.new(
|
269
|
+
:s3_paths)
|
270
|
+
SENSITIVE = []
|
271
|
+
include Aws::Structure
|
272
|
+
end
|
273
|
+
|
242
274
|
# Statistics information about the channel.
|
243
275
|
#
|
244
276
|
# @!attribute [rw] size
|
@@ -251,10 +283,10 @@ module Aws::IoTAnalytics
|
|
251
283
|
include Aws::Structure
|
252
284
|
end
|
253
285
|
|
254
|
-
# Where channel data is stored. You may choose one of
|
255
|
-
#
|
256
|
-
#
|
257
|
-
#
|
286
|
+
# Where channel data is stored. You may choose one of `serviceManagedS3`
|
287
|
+
# or `customerManagedS3` storage. If not specified, the default is
|
288
|
+
# `serviceManagedS3`. This cannot be changed after creation of the
|
289
|
+
# channel.
|
258
290
|
#
|
259
291
|
# @note When making an API call, you may pass ChannelStorage
|
260
292
|
# data as a hash:
|
@@ -270,18 +302,17 @@ module Aws::IoTAnalytics
|
|
270
302
|
# }
|
271
303
|
#
|
272
304
|
# @!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.
|
305
|
+
# Use this to store channel data in an S3 bucket managed by AWS IoT
|
306
|
+
# Analytics. You cannot change the choice of service-managed or
|
307
|
+
# customer-managed S3 storage after the channel is created.
|
277
308
|
# @return [Types::ServiceManagedChannelS3Storage]
|
278
309
|
#
|
279
310
|
# @!attribute [rw] customer_managed_s3
|
280
311
|
# 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
|
-
#
|
312
|
+
# customer managed storage is selected, the `retentionPeriod`
|
313
|
+
# parameter is ignored. You cannot change the choice of
|
314
|
+
# service-managed or customer-managed S3 storage after the channel is
|
315
|
+
# created.
|
285
316
|
# @return [Types::CustomerManagedChannelS3Storage]
|
286
317
|
#
|
287
318
|
class ChannelStorage < Struct.new(
|
@@ -294,8 +325,8 @@ module Aws::IoTAnalytics
|
|
294
325
|
# Where channel data is stored.
|
295
326
|
#
|
296
327
|
# @!attribute [rw] service_managed_s3
|
297
|
-
# Used to store channel data in an S3 bucket managed by
|
298
|
-
# Analytics
|
328
|
+
# Used to store channel data in an S3 bucket managed by AWS IoT
|
329
|
+
# Analytics.
|
299
330
|
# @return [Types::ServiceManagedChannelS3StorageSummary]
|
300
331
|
#
|
301
332
|
# @!attribute [rw] customer_managed_s3
|
@@ -331,17 +362,59 @@ module Aws::IoTAnalytics
|
|
331
362
|
# The last time the channel was updated.
|
332
363
|
# @return [Time]
|
333
364
|
#
|
365
|
+
# @!attribute [rw] last_message_arrival_time
|
366
|
+
# The last time when a new message arrived in the channel.
|
367
|
+
#
|
368
|
+
# AWS IoT Analytics updates this value at most once per minute for one
|
369
|
+
# channel. Hence, the `lastMessageArrivalTime` value is an
|
370
|
+
# approximation.
|
371
|
+
#
|
372
|
+
# This feature only applies to messages that arrived in the data store
|
373
|
+
# after October 23, 2020.
|
374
|
+
# @return [Time]
|
375
|
+
#
|
334
376
|
class ChannelSummary < Struct.new(
|
335
377
|
:channel_name,
|
336
378
|
:channel_storage,
|
337
379
|
:status,
|
338
380
|
:creation_time,
|
339
|
-
:last_update_time
|
381
|
+
:last_update_time,
|
382
|
+
:last_message_arrival_time)
|
383
|
+
SENSITIVE = []
|
384
|
+
include Aws::Structure
|
385
|
+
end
|
386
|
+
|
387
|
+
# Contains information about a column that stores your data.
|
388
|
+
#
|
389
|
+
# @note When making an API call, you may pass Column
|
390
|
+
# data as a hash:
|
391
|
+
#
|
392
|
+
# {
|
393
|
+
# name: "ColumnName", # required
|
394
|
+
# type: "ColumnDataType", # required
|
395
|
+
# }
|
396
|
+
#
|
397
|
+
# @!attribute [rw] name
|
398
|
+
# The name of the column.
|
399
|
+
# @return [String]
|
400
|
+
#
|
401
|
+
# @!attribute [rw] type
|
402
|
+
# The type of data. For more information about the supported data
|
403
|
+
# types, see [Common data types][1] in the *AWS Glue Developer Guide*.
|
404
|
+
#
|
405
|
+
#
|
406
|
+
#
|
407
|
+
# [1]: https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-common.html
|
408
|
+
# @return [String]
|
409
|
+
#
|
410
|
+
class Column < Struct.new(
|
411
|
+
:name,
|
412
|
+
:type)
|
340
413
|
SENSITIVE = []
|
341
414
|
include Aws::Structure
|
342
415
|
end
|
343
416
|
|
344
|
-
# Information
|
417
|
+
# Information required to run the `containerAction` to produce dataset
|
345
418
|
# contents.
|
346
419
|
#
|
347
420
|
# @note When making an API call, you may pass ContainerDatasetAction
|
@@ -371,28 +444,27 @@ module Aws::IoTAnalytics
|
|
371
444
|
#
|
372
445
|
# @!attribute [rw] image
|
373
446
|
# The ARN of the Docker container stored in your account. The Docker
|
374
|
-
# container contains an application and
|
375
|
-
# is used to generate
|
447
|
+
# container contains an application and required support libraries and
|
448
|
+
# is used to generate dataset contents.
|
376
449
|
# @return [String]
|
377
450
|
#
|
378
451
|
# @!attribute [rw] execution_role_arn
|
379
|
-
# The ARN of the role
|
380
|
-
#
|
381
|
-
#
|
382
|
-
#
|
452
|
+
# The ARN of the role that gives permission to the system to access
|
453
|
+
# required resources to run the `containerAction`. This includes, at
|
454
|
+
# minimum, permission to retrieve the dataset contents that are the
|
455
|
+
# input to the containerized application.
|
383
456
|
# @return [String]
|
384
457
|
#
|
385
458
|
# @!attribute [rw] resource_configuration
|
386
|
-
# Configuration of the resource
|
387
|
-
# "containerAction".
|
459
|
+
# Configuration of the resource that executes the `containerAction`.
|
388
460
|
# @return [Types::ResourceConfiguration]
|
389
461
|
#
|
390
462
|
# @!attribute [rw] variables
|
391
|
-
# The values of variables used
|
392
|
-
#
|
463
|
+
# The values of variables used in the context of the execution of the
|
464
|
+
# containerized application (basically, parameters passed to the
|
393
465
|
# application). Each variable must have a name and a value given by
|
394
|
-
# one of
|
395
|
-
#
|
466
|
+
# one of `stringValue`, `datasetContentVersionValue`, or
|
467
|
+
# `outputFileUriValue`.
|
396
468
|
# @return [Array<Types::Variable>]
|
397
469
|
#
|
398
470
|
class ContainerDatasetAction < Struct.new(
|
@@ -435,16 +507,15 @@ module Aws::IoTAnalytics
|
|
435
507
|
# @return [String]
|
436
508
|
#
|
437
509
|
# @!attribute [rw] channel_storage
|
438
|
-
# Where channel data is stored. You
|
439
|
-
#
|
440
|
-
#
|
441
|
-
#
|
510
|
+
# Where channel data is stored. You can choose one of
|
511
|
+
# `serviceManagedS3` or `customerManagedS3` storage. If not specified,
|
512
|
+
# the default is `serviceManagedS3`. You cannot change this storage
|
513
|
+
# option after the channel is created.
|
442
514
|
# @return [Types::ChannelStorage]
|
443
515
|
#
|
444
516
|
# @!attribute [rw] retention_period
|
445
517
|
# How long, in days, message data is kept for the channel. When
|
446
|
-
#
|
447
|
-
# ignored.
|
518
|
+
# `customerManagedS3` storage is selected, this parameter is ignored.
|
448
519
|
# @return [Types::RetentionPeriod]
|
449
520
|
#
|
450
521
|
# @!attribute [rw] tags
|
@@ -485,20 +556,31 @@ module Aws::IoTAnalytics
|
|
485
556
|
#
|
486
557
|
# {
|
487
558
|
# dataset_name: "DatasetName", # required
|
559
|
+
# version_id: "DatasetContentVersion",
|
488
560
|
# }
|
489
561
|
#
|
490
562
|
# @!attribute [rw] dataset_name
|
491
|
-
# The name of the
|
563
|
+
# The name of the dataset.
|
564
|
+
# @return [String]
|
565
|
+
#
|
566
|
+
# @!attribute [rw] version_id
|
567
|
+
# The version ID of the dataset content. To specify `versionId` for a
|
568
|
+
# dataset content, the dataset must use a [DeltaTimer][1] filter.
|
569
|
+
#
|
570
|
+
#
|
571
|
+
#
|
572
|
+
# [1]: https://docs.aws.amazon.com/iotanalytics/latest/APIReference/API_DeltaTime.html
|
492
573
|
# @return [String]
|
493
574
|
#
|
494
575
|
class CreateDatasetContentRequest < Struct.new(
|
495
|
-
:dataset_name
|
576
|
+
:dataset_name,
|
577
|
+
:version_id)
|
496
578
|
SENSITIVE = []
|
497
579
|
include Aws::Structure
|
498
580
|
end
|
499
581
|
|
500
582
|
# @!attribute [rw] version_id
|
501
|
-
# The version ID of the
|
583
|
+
# The version ID of the dataset contents that are being created.
|
502
584
|
# @return [String]
|
503
585
|
#
|
504
586
|
class CreateDatasetContentResponse < Struct.new(
|
@@ -593,6 +675,16 @@ module Aws::IoTAnalytics
|
|
593
675
|
# value: "TagValue", # required
|
594
676
|
# },
|
595
677
|
# ],
|
678
|
+
# late_data_rules: [
|
679
|
+
# {
|
680
|
+
# rule_name: "LateDataRuleName",
|
681
|
+
# rule_configuration: { # required
|
682
|
+
# delta_time_session_window_configuration: {
|
683
|
+
# timeout_in_minutes: 1, # required
|
684
|
+
# },
|
685
|
+
# },
|
686
|
+
# },
|
687
|
+
# ],
|
596
688
|
# }
|
597
689
|
#
|
598
690
|
# @!attribute [rw] dataset_name
|
@@ -607,36 +699,55 @@ module Aws::IoTAnalytics
|
|
607
699
|
# A list of triggers. A trigger causes data set contents to be
|
608
700
|
# populated at a specified time interval or when another data set's
|
609
701
|
# contents are created. The list of triggers can be empty or contain
|
610
|
-
# up to five
|
702
|
+
# up to five `DataSetTrigger` objects.
|
611
703
|
# @return [Array<Types::DatasetTrigger>]
|
612
704
|
#
|
613
705
|
# @!attribute [rw] content_delivery_rules
|
614
|
-
# When
|
706
|
+
# When dataset contents are created, they are delivered to
|
615
707
|
# destinations specified here.
|
616
708
|
# @return [Array<Types::DatasetContentDeliveryRule>]
|
617
709
|
#
|
618
710
|
# @!attribute [rw] retention_period
|
619
|
-
#
|
620
|
-
#
|
621
|
-
#
|
622
|
-
# versions of
|
623
|
-
# `versioningConfiguration` parameter.
|
624
|
-
#
|
711
|
+
# Optional. How long, in days, versions of dataset contents are kept
|
712
|
+
# for the dataset. If not specified or set to `null`, versions of
|
713
|
+
# dataset contents are retained for at most 90 days. The number of
|
714
|
+
# versions of dataset contents retained is determined by the
|
715
|
+
# `versioningConfiguration` parameter. For more information, see
|
716
|
+
# [Keeping Multiple Versions of AWS IoT Analytics Data Sets][1] in the
|
717
|
+
# *AWS IoT Analytics User Guide*.
|
718
|
+
#
|
719
|
+
#
|
720
|
+
#
|
721
|
+
# [1]: https://docs.aws.amazon.com/iotanalytics/latest/userguide/getting-started.html#aws-iot-analytics-dataset-versions
|
625
722
|
# @return [Types::RetentionPeriod]
|
626
723
|
#
|
627
724
|
# @!attribute [rw] versioning_configuration
|
628
|
-
#
|
725
|
+
# Optional. How many versions of dataset contents are kept. If not
|
629
726
|
# specified or set to null, only the latest version plus the latest
|
630
727
|
# succeeded version (if they are different) are kept for the time
|
631
|
-
# period specified by the
|
632
|
-
# information, see
|
633
|
-
#
|
728
|
+
# period specified by the `retentionPeriod` parameter. For more
|
729
|
+
# information, see [Keeping Multiple Versions of AWS IoT Analytics
|
730
|
+
# Data Sets][1] in the *AWS IoT Analytics User Guide*.
|
731
|
+
#
|
732
|
+
#
|
733
|
+
#
|
734
|
+
# [1]: https://docs.aws.amazon.com/iotanalytics/latest/userguide/getting-started.html#aws-iot-analytics-dataset-versions
|
634
735
|
# @return [Types::VersioningConfiguration]
|
635
736
|
#
|
636
737
|
# @!attribute [rw] tags
|
637
738
|
# Metadata which can be used to manage the data set.
|
638
739
|
# @return [Array<Types::Tag>]
|
639
740
|
#
|
741
|
+
# @!attribute [rw] late_data_rules
|
742
|
+
# A list of data rules that send notifications to Amazon CloudWatch,
|
743
|
+
# when data arrives late. To specify `lateDataRules`, the dataset must
|
744
|
+
# use a [DeltaTimer][1] filter.
|
745
|
+
#
|
746
|
+
#
|
747
|
+
#
|
748
|
+
# [1]: https://docs.aws.amazon.com/iotanalytics/latest/APIReference/API_DeltaTime.html
|
749
|
+
# @return [Array<Types::LateDataRule>]
|
750
|
+
#
|
640
751
|
class CreateDatasetRequest < Struct.new(
|
641
752
|
:dataset_name,
|
642
753
|
:actions,
|
@@ -644,21 +755,22 @@ module Aws::IoTAnalytics
|
|
644
755
|
:content_delivery_rules,
|
645
756
|
:retention_period,
|
646
757
|
:versioning_configuration,
|
647
|
-
:tags
|
758
|
+
:tags,
|
759
|
+
:late_data_rules)
|
648
760
|
SENSITIVE = []
|
649
761
|
include Aws::Structure
|
650
762
|
end
|
651
763
|
|
652
764
|
# @!attribute [rw] dataset_name
|
653
|
-
# The name of the
|
765
|
+
# The name of the dataset.
|
654
766
|
# @return [String]
|
655
767
|
#
|
656
768
|
# @!attribute [rw] dataset_arn
|
657
|
-
# The ARN of the
|
769
|
+
# The ARN of the dataset.
|
658
770
|
# @return [String]
|
659
771
|
#
|
660
772
|
# @!attribute [rw] retention_period
|
661
|
-
# How long, in days,
|
773
|
+
# How long, in days, dataset contents are kept for the dataset.
|
662
774
|
# @return [Types::RetentionPeriod]
|
663
775
|
#
|
664
776
|
class CreateDatasetResponse < Struct.new(
|
@@ -693,6 +805,20 @@ module Aws::IoTAnalytics
|
|
693
805
|
# value: "TagValue", # required
|
694
806
|
# },
|
695
807
|
# ],
|
808
|
+
# file_format_configuration: {
|
809
|
+
# json_configuration: {
|
810
|
+
# },
|
811
|
+
# parquet_configuration: {
|
812
|
+
# schema_definition: {
|
813
|
+
# columns: [
|
814
|
+
# {
|
815
|
+
# name: "ColumnName", # required
|
816
|
+
# type: "ColumnDataType", # required
|
817
|
+
# },
|
818
|
+
# ],
|
819
|
+
# },
|
820
|
+
# },
|
821
|
+
# },
|
696
822
|
# }
|
697
823
|
#
|
698
824
|
# @!attribute [rw] datastore_name
|
@@ -700,27 +826,40 @@ module Aws::IoTAnalytics
|
|
700
826
|
# @return [String]
|
701
827
|
#
|
702
828
|
# @!attribute [rw] datastore_storage
|
703
|
-
# Where data store data is stored. You
|
704
|
-
#
|
705
|
-
#
|
706
|
-
#
|
829
|
+
# Where data store data is stored. You can choose one of
|
830
|
+
# `serviceManagedS3` or `customerManagedS3` storage. If not specified,
|
831
|
+
# the default is `serviceManagedS3`. You cannot change this storage
|
832
|
+
# option after the data store is created.
|
707
833
|
# @return [Types::DatastoreStorage]
|
708
834
|
#
|
709
835
|
# @!attribute [rw] retention_period
|
710
836
|
# How long, in days, message data is kept for the data store. When
|
711
|
-
#
|
712
|
-
# ignored.
|
837
|
+
# `customerManagedS3` storage is selected, this parameter is ignored.
|
713
838
|
# @return [Types::RetentionPeriod]
|
714
839
|
#
|
715
840
|
# @!attribute [rw] tags
|
716
841
|
# Metadata which can be used to manage the data store.
|
717
842
|
# @return [Array<Types::Tag>]
|
718
843
|
#
|
844
|
+
# @!attribute [rw] file_format_configuration
|
845
|
+
# Contains the configuration information of file formats. AWS IoT
|
846
|
+
# Analytics data stores support JSON and [Parquet][1].
|
847
|
+
#
|
848
|
+
# The default file format is JSON. You can specify only one format.
|
849
|
+
#
|
850
|
+
# You can't change the file format after you create the data store.
|
851
|
+
#
|
852
|
+
#
|
853
|
+
#
|
854
|
+
# [1]: https://parquet.apache.org/
|
855
|
+
# @return [Types::FileFormatConfiguration]
|
856
|
+
#
|
719
857
|
class CreateDatastoreRequest < Struct.new(
|
720
858
|
:datastore_name,
|
721
859
|
:datastore_storage,
|
722
860
|
:retention_period,
|
723
|
-
:tags
|
861
|
+
:tags,
|
862
|
+
:file_format_configuration)
|
724
863
|
SENSITIVE = []
|
725
864
|
include Aws::Structure
|
726
865
|
end
|
@@ -824,16 +963,16 @@ module Aws::IoTAnalytics
|
|
824
963
|
# @return [String]
|
825
964
|
#
|
826
965
|
# @!attribute [rw] pipeline_activities
|
827
|
-
# A list of
|
966
|
+
# A list of `PipelineActivity` objects. Activities perform
|
828
967
|
# transformations on your messages, such as removing, renaming or
|
829
968
|
# adding message attributes; filtering messages based on attribute
|
830
969
|
# values; invoking your Lambda functions on messages for advanced
|
831
970
|
# processing; or performing mathematical transformations to normalize
|
832
971
|
# device data.
|
833
972
|
#
|
834
|
-
# The list can be 2-25
|
973
|
+
# The list can be 2-25 `PipelineActivity` objects and must contain
|
835
974
|
# both a `channel` and a `datastore` activity. Each entry in the list
|
836
|
-
# must contain only one activity
|
975
|
+
# must contain only one activity. For example:
|
837
976
|
#
|
838
977
|
# `pipelineActivities = [ \{ "channel": \{ ... \} \}, \{ "lambda": \{
|
839
978
|
# ... \} \}, ... ]`
|
@@ -867,10 +1006,9 @@ module Aws::IoTAnalytics
|
|
867
1006
|
end
|
868
1007
|
|
869
1008
|
# 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.
|
1009
|
+
# customer managed storage is selected, the `retentionPeriod` parameter
|
1010
|
+
# is ignored. You cannot change the choice of service-managed or
|
1011
|
+
# customer-managed S3 storage after the channel is created.
|
874
1012
|
#
|
875
1013
|
# @note When making an API call, you may pass CustomerManagedChannelS3Storage
|
876
1014
|
# data as a hash:
|
@@ -882,18 +1020,18 @@ module Aws::IoTAnalytics
|
|
882
1020
|
# }
|
883
1021
|
#
|
884
1022
|
# @!attribute [rw] bucket
|
885
|
-
# The name of the
|
1023
|
+
# The name of the S3 bucket in which channel data is stored.
|
886
1024
|
# @return [String]
|
887
1025
|
#
|
888
1026
|
# @!attribute [rw] key_prefix
|
889
|
-
#
|
890
|
-
# objects. Each object in an
|
891
|
-
#
|
892
|
-
#
|
1027
|
+
# Optional. The prefix used to create the keys of the channel data
|
1028
|
+
# objects. Each object in an S3 bucket has a key that is its unique
|
1029
|
+
# identifier in the bucket. Each object in a bucket has exactly one
|
1030
|
+
# key. The prefix must end with a forward slash (/).
|
893
1031
|
# @return [String]
|
894
1032
|
#
|
895
1033
|
# @!attribute [rw] role_arn
|
896
|
-
# The ARN of the role
|
1034
|
+
# The ARN of the role that grants AWS IoT Analytics permission to
|
897
1035
|
# interact with your Amazon S3 resources.
|
898
1036
|
# @return [String]
|
899
1037
|
#
|
@@ -908,18 +1046,18 @@ module Aws::IoTAnalytics
|
|
908
1046
|
# Used to store channel data in an S3 bucket that you manage.
|
909
1047
|
#
|
910
1048
|
# @!attribute [rw] bucket
|
911
|
-
# The name of the
|
1049
|
+
# The name of the S3 bucket in which channel data is stored.
|
912
1050
|
# @return [String]
|
913
1051
|
#
|
914
1052
|
# @!attribute [rw] key_prefix
|
915
|
-
#
|
916
|
-
# objects. Each object in an
|
917
|
-
#
|
918
|
-
#
|
1053
|
+
# Optional. The prefix used to create the keys of the channel data
|
1054
|
+
# objects. Each object in an S3 bucket has a key that is its unique
|
1055
|
+
# identifier within the bucket (each object in a bucket has exactly
|
1056
|
+
# one key). The prefix must end with a forward slash (/).
|
919
1057
|
# @return [String]
|
920
1058
|
#
|
921
1059
|
# @!attribute [rw] role_arn
|
922
|
-
# The ARN of the role
|
1060
|
+
# The ARN of the role that grants AWS IoT Analytics permission to
|
923
1061
|
# interact with your Amazon S3 resources.
|
924
1062
|
# @return [String]
|
925
1063
|
#
|
@@ -932,10 +1070,9 @@ module Aws::IoTAnalytics
|
|
932
1070
|
end
|
933
1071
|
|
934
1072
|
# 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.
|
1073
|
+
# When customer-managed storage is selected, the `retentionPeriod`
|
1074
|
+
# parameter is ignored. You cannot change the choice of service-managed
|
1075
|
+
# or customer-managed S3 storage after the data store is created.
|
939
1076
|
#
|
940
1077
|
# @note When making an API call, you may pass CustomerManagedDatastoreS3Storage
|
941
1078
|
# data as a hash:
|
@@ -947,18 +1084,18 @@ module Aws::IoTAnalytics
|
|
947
1084
|
# }
|
948
1085
|
#
|
949
1086
|
# @!attribute [rw] bucket
|
950
|
-
# The name of the
|
1087
|
+
# The name of the S3 bucket in which data store data is stored.
|
951
1088
|
# @return [String]
|
952
1089
|
#
|
953
1090
|
# @!attribute [rw] key_prefix
|
954
|
-
#
|
955
|
-
#
|
956
|
-
#
|
957
|
-
#
|
1091
|
+
# Optional. The prefix used to create the keys of the data store data
|
1092
|
+
# objects. Each object in an S3 bucket has a key that is its unique
|
1093
|
+
# identifier in the bucket. Each object in a bucket has exactly one
|
1094
|
+
# key. The prefix must end with a forward slash (/).
|
958
1095
|
# @return [String]
|
959
1096
|
#
|
960
1097
|
# @!attribute [rw] role_arn
|
961
|
-
# The ARN of the role
|
1098
|
+
# The ARN of the role that grants AWS IoT Analytics permission to
|
962
1099
|
# interact with your Amazon S3 resources.
|
963
1100
|
# @return [String]
|
964
1101
|
#
|
@@ -973,18 +1110,18 @@ module Aws::IoTAnalytics
|
|
973
1110
|
# Used to store data store data in an S3 bucket that you manage.
|
974
1111
|
#
|
975
1112
|
# @!attribute [rw] bucket
|
976
|
-
# The name of the
|
1113
|
+
# The name of the S3 bucket in which data store data is stored.
|
977
1114
|
# @return [String]
|
978
1115
|
#
|
979
1116
|
# @!attribute [rw] key_prefix
|
980
|
-
#
|
981
|
-
#
|
982
|
-
#
|
983
|
-
#
|
1117
|
+
# Optional. The prefix used to create the keys of the data store data
|
1118
|
+
# objects. Each object in an S3 bucket has a key that is its unique
|
1119
|
+
# identifier in the bucket. Each object in a bucket has exactly one
|
1120
|
+
# key. The prefix must end with a forward slash (/).
|
984
1121
|
# @return [String]
|
985
1122
|
#
|
986
1123
|
# @!attribute [rw] role_arn
|
987
|
-
# The ARN of the role
|
1124
|
+
# The ARN of the role that grants AWS IoT Analytics permission to
|
988
1125
|
# interact with your Amazon S3 resources.
|
989
1126
|
# @return [String]
|
990
1127
|
#
|
@@ -1007,18 +1144,18 @@ module Aws::IoTAnalytics
|
|
1007
1144
|
# @return [String]
|
1008
1145
|
#
|
1009
1146
|
# @!attribute [rw] actions
|
1010
|
-
# The
|
1147
|
+
# The `DatasetAction` objects that automatically create the data set
|
1011
1148
|
# contents.
|
1012
1149
|
# @return [Array<Types::DatasetAction>]
|
1013
1150
|
#
|
1014
1151
|
# @!attribute [rw] triggers
|
1015
|
-
# The
|
1152
|
+
# The `DatasetTrigger` objects that specify when the data set is
|
1016
1153
|
# automatically updated.
|
1017
1154
|
# @return [Array<Types::DatasetTrigger>]
|
1018
1155
|
#
|
1019
1156
|
# @!attribute [rw] content_delivery_rules
|
1020
|
-
# When
|
1021
|
-
#
|
1157
|
+
# When dataset contents are created they are delivered to destinations
|
1158
|
+
# specified here.
|
1022
1159
|
# @return [Array<Types::DatasetContentDeliveryRule>]
|
1023
1160
|
#
|
1024
1161
|
# @!attribute [rw] status
|
@@ -1034,19 +1171,32 @@ module Aws::IoTAnalytics
|
|
1034
1171
|
# @return [Time]
|
1035
1172
|
#
|
1036
1173
|
# @!attribute [rw] retention_period
|
1037
|
-
#
|
1038
|
-
# set.
|
1174
|
+
# Optional. How long, in days, message data is kept for the data set.
|
1039
1175
|
# @return [Types::RetentionPeriod]
|
1040
1176
|
#
|
1041
1177
|
# @!attribute [rw] versioning_configuration
|
1042
|
-
#
|
1178
|
+
# Optional. How many versions of dataset contents are kept. If not
|
1043
1179
|
# specified or set to null, only the latest version plus the latest
|
1044
1180
|
# succeeded version (if they are different) are kept for the time
|
1045
|
-
# period specified by the
|
1046
|
-
# information, see
|
1047
|
-
#
|
1181
|
+
# period specified by the `retentionPeriod` parameter. For more
|
1182
|
+
# information, see [Keeping Multiple Versions of AWS IoT Analytics
|
1183
|
+
# Data Sets][1] in the *AWS IoT Analytics User Guide*.
|
1184
|
+
#
|
1185
|
+
#
|
1186
|
+
#
|
1187
|
+
# [1]: https://docs.aws.amazon.com/iotanalytics/latest/userguide/getting-started.html#aws-iot-analytics-dataset-versions
|
1048
1188
|
# @return [Types::VersioningConfiguration]
|
1049
1189
|
#
|
1190
|
+
# @!attribute [rw] late_data_rules
|
1191
|
+
# A list of data rules that send notifications to Amazon CloudWatch,
|
1192
|
+
# when data arrives late. To specify `lateDataRules`, the dataset must
|
1193
|
+
# use a [DeltaTimer][1] filter.
|
1194
|
+
#
|
1195
|
+
#
|
1196
|
+
#
|
1197
|
+
# [1]: https://docs.aws.amazon.com/iotanalytics/latest/APIReference/API_DeltaTime.html
|
1198
|
+
# @return [Array<Types::LateDataRule>]
|
1199
|
+
#
|
1050
1200
|
class Dataset < Struct.new(
|
1051
1201
|
:name,
|
1052
1202
|
:arn,
|
@@ -1057,12 +1207,13 @@ module Aws::IoTAnalytics
|
|
1057
1207
|
:creation_time,
|
1058
1208
|
:last_update_time,
|
1059
1209
|
:retention_period,
|
1060
|
-
:versioning_configuration
|
1210
|
+
:versioning_configuration,
|
1211
|
+
:late_data_rules)
|
1061
1212
|
SENSITIVE = []
|
1062
1213
|
include Aws::Structure
|
1063
1214
|
end
|
1064
1215
|
|
1065
|
-
# A
|
1216
|
+
# A `DatasetAction` object that specifies how data set contents are
|
1066
1217
|
# automatically created.
|
1067
1218
|
#
|
1068
1219
|
# @note When making an API call, you may pass DatasetAction
|
@@ -1110,15 +1261,14 @@ module Aws::IoTAnalytics
|
|
1110
1261
|
# @return [String]
|
1111
1262
|
#
|
1112
1263
|
# @!attribute [rw] query_action
|
1113
|
-
# An
|
1264
|
+
# An `SqlQueryDatasetAction` object that uses an SQL query to
|
1114
1265
|
# automatically create data set contents.
|
1115
1266
|
# @return [Types::SqlQueryDatasetAction]
|
1116
1267
|
#
|
1117
1268
|
# @!attribute [rw] container_action
|
1118
|
-
# Information
|
1119
|
-
# application
|
1120
|
-
#
|
1121
|
-
# support libraries.
|
1269
|
+
# Information that allows the system to run a containerized
|
1270
|
+
# application to create the dataset contents. The application must be
|
1271
|
+
# in a Docker container along with any required support libraries.
|
1122
1272
|
# @return [Types::ContainerDatasetAction]
|
1123
1273
|
#
|
1124
1274
|
class DatasetAction < Struct.new(
|
@@ -1129,16 +1279,16 @@ module Aws::IoTAnalytics
|
|
1129
1279
|
include Aws::Structure
|
1130
1280
|
end
|
1131
1281
|
|
1132
|
-
# Information about the action
|
1133
|
-
#
|
1282
|
+
# Information about the action that automatically creates the dataset's
|
1283
|
+
# contents.
|
1134
1284
|
#
|
1135
1285
|
# @!attribute [rw] action_name
|
1136
|
-
# The name of the action
|
1286
|
+
# The name of the action that automatically creates the dataset's
|
1137
1287
|
# contents.
|
1138
1288
|
# @return [String]
|
1139
1289
|
#
|
1140
1290
|
# @!attribute [rw] action_type
|
1141
|
-
# The type of action by which the
|
1291
|
+
# The type of action by which the dataset's contents are
|
1142
1292
|
# automatically created.
|
1143
1293
|
# @return [String]
|
1144
1294
|
#
|
@@ -1149,7 +1299,7 @@ module Aws::IoTAnalytics
|
|
1149
1299
|
include Aws::Structure
|
1150
1300
|
end
|
1151
1301
|
|
1152
|
-
# The destination to which
|
1302
|
+
# The destination to which dataset contents are delivered.
|
1153
1303
|
#
|
1154
1304
|
# @note When making an API call, you may pass DatasetContentDeliveryDestination
|
1155
1305
|
# data as a hash:
|
@@ -1171,13 +1321,13 @@ module Aws::IoTAnalytics
|
|
1171
1321
|
# }
|
1172
1322
|
#
|
1173
1323
|
# @!attribute [rw] iot_events_destination_configuration
|
1174
|
-
# Configuration information for delivery of
|
1324
|
+
# Configuration information for delivery of dataset contents to AWS
|
1175
1325
|
# IoT Events.
|
1176
1326
|
# @return [Types::IotEventsDestinationConfiguration]
|
1177
1327
|
#
|
1178
1328
|
# @!attribute [rw] s3_destination_configuration
|
1179
|
-
# Configuration information for delivery of
|
1180
|
-
#
|
1329
|
+
# Configuration information for delivery of dataset contents to Amazon
|
1330
|
+
# S3.
|
1181
1331
|
# @return [Types::S3DestinationConfiguration]
|
1182
1332
|
#
|
1183
1333
|
class DatasetContentDeliveryDestination < Struct.new(
|
@@ -1187,7 +1337,7 @@ module Aws::IoTAnalytics
|
|
1187
1337
|
include Aws::Structure
|
1188
1338
|
end
|
1189
1339
|
|
1190
|
-
# When
|
1340
|
+
# When dataset contents are created, they are delivered to destination
|
1191
1341
|
# specified here.
|
1192
1342
|
#
|
1193
1343
|
# @note When making an API call, you may pass DatasetContentDeliveryRule
|
@@ -1213,11 +1363,11 @@ module Aws::IoTAnalytics
|
|
1213
1363
|
# }
|
1214
1364
|
#
|
1215
1365
|
# @!attribute [rw] entry_name
|
1216
|
-
# The name of the
|
1366
|
+
# The name of the dataset content delivery rules entry.
|
1217
1367
|
# @return [String]
|
1218
1368
|
#
|
1219
1369
|
# @!attribute [rw] destination
|
1220
|
-
# The destination to which
|
1370
|
+
# The destination to which dataset contents are delivered.
|
1221
1371
|
# @return [Types::DatasetContentDeliveryDestination]
|
1222
1372
|
#
|
1223
1373
|
class DatasetContentDeliveryRule < Struct.new(
|
@@ -1231,8 +1381,8 @@ module Aws::IoTAnalytics
|
|
1231
1381
|
# state.
|
1232
1382
|
#
|
1233
1383
|
# @!attribute [rw] state
|
1234
|
-
# The state of the data set contents. Can be one of
|
1235
|
-
#
|
1384
|
+
# The state of the data set contents. Can be one of READY, CREATING,
|
1385
|
+
# SUCCEEDED, or FAILED.
|
1236
1386
|
# @return [String]
|
1237
1387
|
#
|
1238
1388
|
# @!attribute [rw] reason
|
@@ -1246,10 +1396,10 @@ module Aws::IoTAnalytics
|
|
1246
1396
|
include Aws::Structure
|
1247
1397
|
end
|
1248
1398
|
|
1249
|
-
# Summary information about
|
1399
|
+
# Summary information about dataset contents.
|
1250
1400
|
#
|
1251
1401
|
# @!attribute [rw] version
|
1252
|
-
# The version of the
|
1402
|
+
# The version of the dataset contents.
|
1253
1403
|
# @return [String]
|
1254
1404
|
#
|
1255
1405
|
# @!attribute [rw] status
|
@@ -1257,11 +1407,11 @@ module Aws::IoTAnalytics
|
|
1257
1407
|
# @return [Types::DatasetContentStatus]
|
1258
1408
|
#
|
1259
1409
|
# @!attribute [rw] creation_time
|
1260
|
-
# The actual time the creation of the
|
1410
|
+
# The actual time the creation of the dataset contents was started.
|
1261
1411
|
# @return [Time]
|
1262
1412
|
#
|
1263
1413
|
# @!attribute [rw] schedule_time
|
1264
|
-
# The time the creation of the
|
1414
|
+
# The time the creation of the dataset contents was scheduled to
|
1265
1415
|
# start.
|
1266
1416
|
# @return [Time]
|
1267
1417
|
#
|
@@ -1280,8 +1430,8 @@ module Aws::IoTAnalytics
|
|
1280
1430
|
include Aws::Structure
|
1281
1431
|
end
|
1282
1432
|
|
1283
|
-
# The
|
1284
|
-
#
|
1433
|
+
# The dataset whose latest contents are used as input to the notebook or
|
1434
|
+
# application.
|
1285
1435
|
#
|
1286
1436
|
# @note When making an API call, you may pass DatasetContentVersionValue
|
1287
1437
|
# data as a hash:
|
@@ -1291,7 +1441,7 @@ module Aws::IoTAnalytics
|
|
1291
1441
|
# }
|
1292
1442
|
#
|
1293
1443
|
# @!attribute [rw] dataset_name
|
1294
|
-
# The name of the
|
1444
|
+
# The name of the dataset whose latest contents are used as input to
|
1295
1445
|
# the notebook or application.
|
1296
1446
|
# @return [String]
|
1297
1447
|
#
|
@@ -1308,7 +1458,7 @@ module Aws::IoTAnalytics
|
|
1308
1458
|
# @return [String]
|
1309
1459
|
#
|
1310
1460
|
# @!attribute [rw] data_uri
|
1311
|
-
# The
|
1461
|
+
# The presigned URI of the data set item.
|
1312
1462
|
# @return [String]
|
1313
1463
|
#
|
1314
1464
|
class DatasetEntry < Struct.new(
|
@@ -1340,11 +1490,11 @@ module Aws::IoTAnalytics
|
|
1340
1490
|
# A list of triggers. A trigger causes data set content to be
|
1341
1491
|
# populated at a specified time interval or when another data set is
|
1342
1492
|
# populated. The list of triggers can be empty or contain up to five
|
1343
|
-
# DataSetTrigger objects
|
1493
|
+
# `DataSetTrigger` objects
|
1344
1494
|
# @return [Array<Types::DatasetTrigger>]
|
1345
1495
|
#
|
1346
1496
|
# @!attribute [rw] actions
|
1347
|
-
# A list of
|
1497
|
+
# A list of `DataActionSummary` objects.
|
1348
1498
|
# @return [Array<Types::DatasetActionSummary>]
|
1349
1499
|
#
|
1350
1500
|
class DatasetSummary < Struct.new(
|
@@ -1358,8 +1508,8 @@ module Aws::IoTAnalytics
|
|
1358
1508
|
include Aws::Structure
|
1359
1509
|
end
|
1360
1510
|
|
1361
|
-
# The
|
1362
|
-
#
|
1511
|
+
# The `DatasetTrigger` that specifies when the data set is automatically
|
1512
|
+
# updated.
|
1363
1513
|
#
|
1364
1514
|
# @note When making an API call, you may pass DatasetTrigger
|
1365
1515
|
# data as a hash:
|
@@ -1374,7 +1524,7 @@ module Aws::IoTAnalytics
|
|
1374
1524
|
# }
|
1375
1525
|
#
|
1376
1526
|
# @!attribute [rw] schedule
|
1377
|
-
# The
|
1527
|
+
# The Schedule when the trigger is initiated.
|
1378
1528
|
# @return [Types::Schedule]
|
1379
1529
|
#
|
1380
1530
|
# @!attribute [rw] dataset
|
@@ -1396,10 +1546,10 @@ module Aws::IoTAnalytics
|
|
1396
1546
|
# @return [String]
|
1397
1547
|
#
|
1398
1548
|
# @!attribute [rw] storage
|
1399
|
-
# Where data store data is stored. You
|
1400
|
-
#
|
1401
|
-
#
|
1402
|
-
#
|
1549
|
+
# Where data store data is stored. You can choose one of
|
1550
|
+
# `serviceManagedS3` or `customerManagedS3` storage. If not specified,
|
1551
|
+
# the default is `serviceManagedS3`. You cannot change this storage
|
1552
|
+
# option after the data store is created.
|
1403
1553
|
# @return [Types::DatastoreStorage]
|
1404
1554
|
#
|
1405
1555
|
# @!attribute [rw] arn
|
@@ -1424,8 +1574,7 @@ module Aws::IoTAnalytics
|
|
1424
1574
|
#
|
1425
1575
|
# @!attribute [rw] retention_period
|
1426
1576
|
# How long, in days, message data is kept for the data store. When
|
1427
|
-
#
|
1428
|
-
# ignored.
|
1577
|
+
# `customerManagedS3` storage is selected, this parameter is ignored.
|
1429
1578
|
# @return [Types::RetentionPeriod]
|
1430
1579
|
#
|
1431
1580
|
# @!attribute [rw] creation_time
|
@@ -1436,6 +1585,30 @@ module Aws::IoTAnalytics
|
|
1436
1585
|
# The last time the data store was updated.
|
1437
1586
|
# @return [Time]
|
1438
1587
|
#
|
1588
|
+
# @!attribute [rw] last_message_arrival_time
|
1589
|
+
# The last time when a new message arrived in the data store.
|
1590
|
+
#
|
1591
|
+
# AWS IoT Analytics updates this value at most once per minute for one
|
1592
|
+
# data store. Hence, the `lastMessageArrivalTime` value is an
|
1593
|
+
# approximation.
|
1594
|
+
#
|
1595
|
+
# This feature only applies to messages that arrived in the data store
|
1596
|
+
# after October 23, 2020.
|
1597
|
+
# @return [Time]
|
1598
|
+
#
|
1599
|
+
# @!attribute [rw] file_format_configuration
|
1600
|
+
# Contains the configuration information of file formats. AWS IoT
|
1601
|
+
# Analytics data stores support JSON and [Parquet][1].
|
1602
|
+
#
|
1603
|
+
# The default file format is JSON. You can specify only one format.
|
1604
|
+
#
|
1605
|
+
# You can't change the file format after you create the data store.
|
1606
|
+
#
|
1607
|
+
#
|
1608
|
+
#
|
1609
|
+
# [1]: https://parquet.apache.org/
|
1610
|
+
# @return [Types::FileFormatConfiguration]
|
1611
|
+
#
|
1439
1612
|
class Datastore < Struct.new(
|
1440
1613
|
:name,
|
1441
1614
|
:storage,
|
@@ -1443,12 +1616,14 @@ module Aws::IoTAnalytics
|
|
1443
1616
|
:status,
|
1444
1617
|
:retention_period,
|
1445
1618
|
:creation_time,
|
1446
|
-
:last_update_time
|
1619
|
+
:last_update_time,
|
1620
|
+
:last_message_arrival_time,
|
1621
|
+
:file_format_configuration)
|
1447
1622
|
SENSITIVE = []
|
1448
1623
|
include Aws::Structure
|
1449
1624
|
end
|
1450
1625
|
|
1451
|
-
# The
|
1626
|
+
# The datastore activity that specifies where to store the processed
|
1452
1627
|
# data.
|
1453
1628
|
#
|
1454
1629
|
# @note When making an API call, you may pass DatastoreActivity
|
@@ -1460,7 +1635,7 @@ module Aws::IoTAnalytics
|
|
1460
1635
|
# }
|
1461
1636
|
#
|
1462
1637
|
# @!attribute [rw] name
|
1463
|
-
# The name of the
|
1638
|
+
# The name of the datastore activity.
|
1464
1639
|
# @return [String]
|
1465
1640
|
#
|
1466
1641
|
# @!attribute [rw] datastore_name
|
@@ -1486,10 +1661,10 @@ module Aws::IoTAnalytics
|
|
1486
1661
|
include Aws::Structure
|
1487
1662
|
end
|
1488
1663
|
|
1489
|
-
# Where data store data is stored. You
|
1490
|
-
#
|
1491
|
-
#
|
1492
|
-
# after the data store is created.
|
1664
|
+
# Where data store data is stored. You can choose one of
|
1665
|
+
# `serviceManagedS3` or `customerManagedS3` storage. If not specified,
|
1666
|
+
# the default is `serviceManagedS3`. You cannot change this storage
|
1667
|
+
# option after the data store is created.
|
1493
1668
|
#
|
1494
1669
|
# @note When making an API call, you may pass DatastoreStorage
|
1495
1670
|
# data as a hash:
|
@@ -1505,15 +1680,14 @@ module Aws::IoTAnalytics
|
|
1505
1680
|
# }
|
1506
1681
|
#
|
1507
1682
|
# @!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.
|
1683
|
+
# Use this to store data store data in an S3 bucket managed by AWS IoT
|
1684
|
+
# Analytics. You cannot change the choice of service-managed or
|
1685
|
+
# customer-managed S3 storage after the data store is created.
|
1512
1686
|
# @return [Types::ServiceManagedDatastoreS3Storage]
|
1513
1687
|
#
|
1514
1688
|
# @!attribute [rw] customer_managed_s3
|
1515
1689
|
# Use this to store data store data in an S3 bucket that you manage.
|
1516
|
-
# When customer managed storage is selected, the
|
1690
|
+
# When customer managed storage is selected, the `retentionPeriod`
|
1517
1691
|
# parameter is ignored. The choice of service-managed or
|
1518
1692
|
# customer-managed S3 storage cannot be changed after creation of the
|
1519
1693
|
# data store.
|
@@ -1529,8 +1703,8 @@ module Aws::IoTAnalytics
|
|
1529
1703
|
# Where data store data is stored.
|
1530
1704
|
#
|
1531
1705
|
# @!attribute [rw] service_managed_s3
|
1532
|
-
# Used to store data store data in an S3 bucket managed by
|
1533
|
-
# Analytics
|
1706
|
+
# Used to store data store data in an S3 bucket managed by AWS IoT
|
1707
|
+
# Analytics.
|
1534
1708
|
# @return [Types::ServiceManagedDatastoreS3StorageSummary]
|
1535
1709
|
#
|
1536
1710
|
# @!attribute [rw] customer_managed_s3
|
@@ -1566,12 +1740,29 @@ module Aws::IoTAnalytics
|
|
1566
1740
|
# The last time the data store was updated.
|
1567
1741
|
# @return [Time]
|
1568
1742
|
#
|
1743
|
+
# @!attribute [rw] last_message_arrival_time
|
1744
|
+
# The last time when a new message arrived in the data store.
|
1745
|
+
#
|
1746
|
+
# AWS IoT Analytics updates this value at most once per minute for one
|
1747
|
+
# data store. Hence, the `lastMessageArrivalTime` value is an
|
1748
|
+
# approximation.
|
1749
|
+
#
|
1750
|
+
# This feature only applies to messages that arrived in the data store
|
1751
|
+
# after October 23, 2020.
|
1752
|
+
# @return [Time]
|
1753
|
+
#
|
1754
|
+
# @!attribute [rw] file_format_type
|
1755
|
+
# The file format of the data in the data store.
|
1756
|
+
# @return [String]
|
1757
|
+
#
|
1569
1758
|
class DatastoreSummary < Struct.new(
|
1570
1759
|
:datastore_name,
|
1571
1760
|
:datastore_storage,
|
1572
1761
|
:status,
|
1573
1762
|
:creation_time,
|
1574
|
-
:last_update_time
|
1763
|
+
:last_update_time,
|
1764
|
+
:last_message_arrival_time,
|
1765
|
+
:file_format_type)
|
1575
1766
|
SENSITIVE = []
|
1576
1767
|
include Aws::Structure
|
1577
1768
|
end
|
@@ -1602,11 +1793,11 @@ module Aws::IoTAnalytics
|
|
1602
1793
|
# }
|
1603
1794
|
#
|
1604
1795
|
# @!attribute [rw] dataset_name
|
1605
|
-
# The name of the
|
1796
|
+
# The name of the dataset whose content is deleted.
|
1606
1797
|
# @return [String]
|
1607
1798
|
#
|
1608
1799
|
# @!attribute [rw] version_id
|
1609
|
-
# The version of the
|
1800
|
+
# The version of the dataset whose content is deleted. You can also
|
1610
1801
|
# use the strings "$LATEST" or "$LATEST\_SUCCEEDED" to delete the
|
1611
1802
|
# latest or latest successfully completed data set. If not specified,
|
1612
1803
|
# "$LATEST\_SUCCEEDED" is the default.
|
@@ -1682,22 +1873,21 @@ module Aws::IoTAnalytics
|
|
1682
1873
|
# }
|
1683
1874
|
#
|
1684
1875
|
# @!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.
|
1876
|
+
# The number of seconds of estimated in-flight lag time of message
|
1877
|
+
# data. When you create dataset contents using message data from a
|
1878
|
+
# specified timeframe, some message data might still be in flight when
|
1879
|
+
# processing begins, and so do not arrive in time to be processed. Use
|
1880
|
+
# this field to make allowances for the in flight time of your message
|
1881
|
+
# data, so that data not processed from a previous timeframe is
|
1882
|
+
# included with the next timeframe. Otherwise, missed message data
|
1883
|
+
# would be excluded from processing during the next timeframe too,
|
1884
|
+
# because its timestamp places it within the previous timeframe.
|
1695
1885
|
# @return [Integer]
|
1696
1886
|
#
|
1697
1887
|
# @!attribute [rw] time_expression
|
1698
|
-
# An expression by which the time of the message data
|
1699
|
-
# determined. This
|
1700
|
-
# expression
|
1888
|
+
# An expression by which the time of the message data might be
|
1889
|
+
# determined. This can be the name of a timestamp field or a SQL
|
1890
|
+
# expression that is used to derive the time the message data was
|
1701
1891
|
# generated.
|
1702
1892
|
# @return [String]
|
1703
1893
|
#
|
@@ -1708,6 +1898,48 @@ module Aws::IoTAnalytics
|
|
1708
1898
|
include Aws::Structure
|
1709
1899
|
end
|
1710
1900
|
|
1901
|
+
# A structure that contains the configuration information of a delta
|
1902
|
+
# time session window.
|
1903
|
+
#
|
1904
|
+
# [ `DeltaTime` ][1] specifies a time interval. You can use `DeltaTime`
|
1905
|
+
# to create dataset contents with data that has arrived in the data
|
1906
|
+
# store since the last execution. For an example of `DeltaTime`, see [
|
1907
|
+
# Creating a SQL dataset with a delta window (CLI)][2] in the *AWS IoT
|
1908
|
+
# Analytics User Guide*.
|
1909
|
+
#
|
1910
|
+
#
|
1911
|
+
#
|
1912
|
+
# [1]: https://docs.aws.amazon.com/iotanalytics/latest/APIReference/API_DeltaTime.html
|
1913
|
+
# [2]: https://docs.aws.amazon.com/iotanalytics/latest/userguide/automate-create-dataset.html#automate-example6
|
1914
|
+
#
|
1915
|
+
# @note When making an API call, you may pass DeltaTimeSessionWindowConfiguration
|
1916
|
+
# data as a hash:
|
1917
|
+
#
|
1918
|
+
# {
|
1919
|
+
# timeout_in_minutes: 1, # required
|
1920
|
+
# }
|
1921
|
+
#
|
1922
|
+
# @!attribute [rw] timeout_in_minutes
|
1923
|
+
# A time interval. You can use `timeoutInMinutes` so that AWS IoT
|
1924
|
+
# Analytics can batch up late data notifications that have been
|
1925
|
+
# generated since the last execution. AWS IoT Analytics sends one
|
1926
|
+
# batch of notifications to Amazon CloudWatch Events at one time.
|
1927
|
+
#
|
1928
|
+
# For more information about how to write a timestamp expression, see
|
1929
|
+
# [Date and Time Functions and Operators][1], in the *Presto 0.172
|
1930
|
+
# Documentation*.
|
1931
|
+
#
|
1932
|
+
#
|
1933
|
+
#
|
1934
|
+
# [1]: https://prestodb.io/docs/0.172/functions/datetime.html
|
1935
|
+
# @return [Integer]
|
1936
|
+
#
|
1937
|
+
class DeltaTimeSessionWindowConfiguration < Struct.new(
|
1938
|
+
:timeout_in_minutes)
|
1939
|
+
SENSITIVE = []
|
1940
|
+
include Aws::Structure
|
1941
|
+
end
|
1942
|
+
|
1711
1943
|
# @note When making an API call, you may pass DescribeChannelRequest
|
1712
1944
|
# data as a hash:
|
1713
1945
|
#
|
@@ -1738,8 +1970,8 @@ module Aws::IoTAnalytics
|
|
1738
1970
|
# @return [Types::Channel]
|
1739
1971
|
#
|
1740
1972
|
# @!attribute [rw] statistics
|
1741
|
-
# Statistics about the channel. Included if the
|
1742
|
-
# parameter is set to true in the request.
|
1973
|
+
# Statistics about the channel. Included if the `includeStatistics`
|
1974
|
+
# parameter is set to `true` in the request.
|
1743
1975
|
# @return [Types::ChannelStatistics]
|
1744
1976
|
#
|
1745
1977
|
class DescribeChannelResponse < Struct.new(
|
@@ -1807,7 +2039,7 @@ module Aws::IoTAnalytics
|
|
1807
2039
|
#
|
1808
2040
|
# @!attribute [rw] statistics
|
1809
2041
|
# Additional statistical information about the data store. Included if
|
1810
|
-
# the
|
2042
|
+
# the `includeStatistics` parameter is set to `true` in the request.
|
1811
2043
|
# @return [Types::DatastoreStatistics]
|
1812
2044
|
#
|
1813
2045
|
class DescribeDatastoreResponse < Struct.new(
|
@@ -1849,7 +2081,7 @@ module Aws::IoTAnalytics
|
|
1849
2081
|
end
|
1850
2082
|
|
1851
2083
|
# @!attribute [rw] pipeline
|
1852
|
-
# A
|
2084
|
+
# A `Pipeline` object that contains information about the pipeline.
|
1853
2085
|
# @return [Types::Pipeline]
|
1854
2086
|
#
|
1855
2087
|
class DescribePipelineResponse < Struct.new(
|
@@ -1873,7 +2105,7 @@ module Aws::IoTAnalytics
|
|
1873
2105
|
# }
|
1874
2106
|
#
|
1875
2107
|
# @!attribute [rw] name
|
1876
|
-
# The name of the
|
2108
|
+
# The name of the `deviceRegistryEnrich` activity.
|
1877
2109
|
# @return [String]
|
1878
2110
|
#
|
1879
2111
|
# @!attribute [rw] attribute
|
@@ -1904,7 +2136,7 @@ module Aws::IoTAnalytics
|
|
1904
2136
|
include Aws::Structure
|
1905
2137
|
end
|
1906
2138
|
|
1907
|
-
# An activity that adds information from the AWS IoT Device
|
2139
|
+
# An activity that adds information from the AWS IoT Device Shadow
|
1908
2140
|
# service to a message.
|
1909
2141
|
#
|
1910
2142
|
# @note When making an API call, you may pass DeviceShadowEnrichActivity
|
@@ -1919,7 +2151,7 @@ module Aws::IoTAnalytics
|
|
1919
2151
|
# }
|
1920
2152
|
#
|
1921
2153
|
# @!attribute [rw] name
|
1922
|
-
# The name of the
|
2154
|
+
# The name of the `deviceShadowEnrich` activity.
|
1923
2155
|
# @return [String]
|
1924
2156
|
#
|
1925
2157
|
# @!attribute [rw] attribute
|
@@ -1952,7 +2184,7 @@ module Aws::IoTAnalytics
|
|
1952
2184
|
# The estimated size of the resource.
|
1953
2185
|
#
|
1954
2186
|
# @!attribute [rw] estimated_size_in_bytes
|
1955
|
-
# The estimated size of the resource in bytes.
|
2187
|
+
# The estimated size of the resource, in bytes.
|
1956
2188
|
# @return [Float]
|
1957
2189
|
#
|
1958
2190
|
# @!attribute [rw] estimated_on
|
@@ -1966,6 +2198,50 @@ module Aws::IoTAnalytics
|
|
1966
2198
|
include Aws::Structure
|
1967
2199
|
end
|
1968
2200
|
|
2201
|
+
# Contains the configuration information of file formats. AWS IoT
|
2202
|
+
# Analytics data stores support JSON and [Parquet][1].
|
2203
|
+
#
|
2204
|
+
# The default file format is JSON. You can specify only one format.
|
2205
|
+
#
|
2206
|
+
# You can't change the file format after you create the data store.
|
2207
|
+
#
|
2208
|
+
#
|
2209
|
+
#
|
2210
|
+
# [1]: https://parquet.apache.org/
|
2211
|
+
#
|
2212
|
+
# @note When making an API call, you may pass FileFormatConfiguration
|
2213
|
+
# data as a hash:
|
2214
|
+
#
|
2215
|
+
# {
|
2216
|
+
# json_configuration: {
|
2217
|
+
# },
|
2218
|
+
# parquet_configuration: {
|
2219
|
+
# schema_definition: {
|
2220
|
+
# columns: [
|
2221
|
+
# {
|
2222
|
+
# name: "ColumnName", # required
|
2223
|
+
# type: "ColumnDataType", # required
|
2224
|
+
# },
|
2225
|
+
# ],
|
2226
|
+
# },
|
2227
|
+
# },
|
2228
|
+
# }
|
2229
|
+
#
|
2230
|
+
# @!attribute [rw] json_configuration
|
2231
|
+
# Contains the configuration information of the JSON format.
|
2232
|
+
# @return [Types::JsonConfiguration]
|
2233
|
+
#
|
2234
|
+
# @!attribute [rw] parquet_configuration
|
2235
|
+
# Contains the configuration information of the Parquet format.
|
2236
|
+
# @return [Types::ParquetConfiguration]
|
2237
|
+
#
|
2238
|
+
class FileFormatConfiguration < Struct.new(
|
2239
|
+
:json_configuration,
|
2240
|
+
:parquet_configuration)
|
2241
|
+
SENSITIVE = []
|
2242
|
+
include Aws::Structure
|
2243
|
+
end
|
2244
|
+
|
1969
2245
|
# An activity that filters a message based on its attributes.
|
1970
2246
|
#
|
1971
2247
|
# @note When making an API call, you may pass FilterActivity
|
@@ -1978,12 +2254,13 @@ module Aws::IoTAnalytics
|
|
1978
2254
|
# }
|
1979
2255
|
#
|
1980
2256
|
# @!attribute [rw] name
|
1981
|
-
# The name of the
|
2257
|
+
# The name of the filter activity.
|
1982
2258
|
# @return [String]
|
1983
2259
|
#
|
1984
2260
|
# @!attribute [rw] filter
|
1985
2261
|
# An expression that looks like a SQL WHERE clause that must return a
|
1986
|
-
# Boolean value.
|
2262
|
+
# Boolean value. Messages that satisfy the condition are passed to the
|
2263
|
+
# next activity.
|
1987
2264
|
# @return [String]
|
1988
2265
|
#
|
1989
2266
|
# @!attribute [rw] next
|
@@ -2025,7 +2302,7 @@ module Aws::IoTAnalytics
|
|
2025
2302
|
end
|
2026
2303
|
|
2027
2304
|
# @!attribute [rw] entries
|
2028
|
-
# A list of
|
2305
|
+
# A list of `DatasetEntry` objects.
|
2029
2306
|
# @return [Array<Types::DatasetEntry>]
|
2030
2307
|
#
|
2031
2308
|
# @!attribute [rw] timestamp
|
@@ -2044,8 +2321,8 @@ module Aws::IoTAnalytics
|
|
2044
2321
|
include Aws::Structure
|
2045
2322
|
end
|
2046
2323
|
|
2047
|
-
# Configuration information for coordination with
|
2048
|
-
#
|
2324
|
+
# Configuration information for coordination with AWS Glue, a fully
|
2325
|
+
# managed extract, transform and load (ETL) service.
|
2049
2326
|
#
|
2050
2327
|
# @note When making an API call, you may pass GlueConfiguration
|
2051
2328
|
# data as a hash:
|
@@ -2056,16 +2333,15 @@ module Aws::IoTAnalytics
|
|
2056
2333
|
# }
|
2057
2334
|
#
|
2058
2335
|
# @!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.)
|
2336
|
+
# The name of the table in your AWS Glue Data Catalog that is used to
|
2337
|
+
# perform the ETL operations. An AWS Glue Data Catalog table contains
|
2338
|
+
# partitioned data and descriptions of data sources and targets.
|
2063
2339
|
# @return [String]
|
2064
2340
|
#
|
2065
2341
|
# @!attribute [rw] database_name
|
2066
2342
|
# The name of the database in your AWS Glue Data Catalog in which the
|
2067
|
-
# table is located.
|
2068
|
-
#
|
2343
|
+
# table is located. An AWS Glue Data Catalog database contains
|
2344
|
+
# metadata tables.
|
2069
2345
|
# @return [String]
|
2070
2346
|
#
|
2071
2347
|
class GlueConfiguration < Struct.new(
|
@@ -2097,7 +2373,7 @@ module Aws::IoTAnalytics
|
|
2097
2373
|
include Aws::Structure
|
2098
2374
|
end
|
2099
2375
|
|
2100
|
-
# Configuration information for delivery of
|
2376
|
+
# Configuration information for delivery of dataset contents to AWS IoT
|
2101
2377
|
# Events.
|
2102
2378
|
#
|
2103
2379
|
# @note When making an API call, you may pass IotEventsDestinationConfiguration
|
@@ -2109,13 +2385,13 @@ module Aws::IoTAnalytics
|
|
2109
2385
|
# }
|
2110
2386
|
#
|
2111
2387
|
# @!attribute [rw] input_name
|
2112
|
-
# The name of the AWS IoT Events input to which
|
2388
|
+
# The name of the AWS IoT Events input to which dataset contents are
|
2113
2389
|
# delivered.
|
2114
2390
|
# @return [String]
|
2115
2391
|
#
|
2116
2392
|
# @!attribute [rw] role_arn
|
2117
|
-
# The ARN of the role
|
2118
|
-
# deliver
|
2393
|
+
# The ARN of the role that grants AWS IoT Analytics permission to
|
2394
|
+
# deliver dataset contents to an AWS IoT Events input.
|
2119
2395
|
# @return [String]
|
2120
2396
|
#
|
2121
2397
|
class IotEventsDestinationConfiguration < Struct.new(
|
@@ -2125,6 +2401,12 @@ module Aws::IoTAnalytics
|
|
2125
2401
|
include Aws::Structure
|
2126
2402
|
end
|
2127
2403
|
|
2404
|
+
# Contains the configuration information of the JSON format.
|
2405
|
+
#
|
2406
|
+
# @api private
|
2407
|
+
#
|
2408
|
+
class JsonConfiguration < Aws::EmptyStructure; end
|
2409
|
+
|
2128
2410
|
# An activity that runs a Lambda function to modify the message.
|
2129
2411
|
#
|
2130
2412
|
# @note When making an API call, you may pass LambdaActivity
|
@@ -2138,7 +2420,7 @@ module Aws::IoTAnalytics
|
|
2138
2420
|
# }
|
2139
2421
|
#
|
2140
2422
|
# @!attribute [rw] name
|
2141
|
-
# The name of the
|
2423
|
+
# The name of the lambda activity.
|
2142
2424
|
# @return [String]
|
2143
2425
|
#
|
2144
2426
|
# @!attribute [rw] lambda_name
|
@@ -2148,9 +2430,9 @@ module Aws::IoTAnalytics
|
|
2148
2430
|
# @!attribute [rw] batch_size
|
2149
2431
|
# The number of messages passed to the Lambda function for processing.
|
2150
2432
|
#
|
2151
|
-
# The
|
2152
|
-
#
|
2153
|
-
#
|
2433
|
+
# The Lambda function must be able to process all of these messages
|
2434
|
+
# within five minutes, which is the maximum timeout duration for
|
2435
|
+
# Lambda functions.
|
2154
2436
|
# @return [Integer]
|
2155
2437
|
#
|
2156
2438
|
# @!attribute [rw] next
|
@@ -2166,6 +2448,57 @@ module Aws::IoTAnalytics
|
|
2166
2448
|
include Aws::Structure
|
2167
2449
|
end
|
2168
2450
|
|
2451
|
+
# A structure that contains the name and configuration information of a
|
2452
|
+
# late data rule.
|
2453
|
+
#
|
2454
|
+
# @note When making an API call, you may pass LateDataRule
|
2455
|
+
# data as a hash:
|
2456
|
+
#
|
2457
|
+
# {
|
2458
|
+
# rule_name: "LateDataRuleName",
|
2459
|
+
# rule_configuration: { # required
|
2460
|
+
# delta_time_session_window_configuration: {
|
2461
|
+
# timeout_in_minutes: 1, # required
|
2462
|
+
# },
|
2463
|
+
# },
|
2464
|
+
# }
|
2465
|
+
#
|
2466
|
+
# @!attribute [rw] rule_name
|
2467
|
+
# The name of the late data rule.
|
2468
|
+
# @return [String]
|
2469
|
+
#
|
2470
|
+
# @!attribute [rw] rule_configuration
|
2471
|
+
# The information needed to configure the late data rule.
|
2472
|
+
# @return [Types::LateDataRuleConfiguration]
|
2473
|
+
#
|
2474
|
+
class LateDataRule < Struct.new(
|
2475
|
+
:rule_name,
|
2476
|
+
:rule_configuration)
|
2477
|
+
SENSITIVE = []
|
2478
|
+
include Aws::Structure
|
2479
|
+
end
|
2480
|
+
|
2481
|
+
# The information needed to configure a delta time session window.
|
2482
|
+
#
|
2483
|
+
# @note When making an API call, you may pass LateDataRuleConfiguration
|
2484
|
+
# data as a hash:
|
2485
|
+
#
|
2486
|
+
# {
|
2487
|
+
# delta_time_session_window_configuration: {
|
2488
|
+
# timeout_in_minutes: 1, # required
|
2489
|
+
# },
|
2490
|
+
# }
|
2491
|
+
#
|
2492
|
+
# @!attribute [rw] delta_time_session_window_configuration
|
2493
|
+
# The information needed to configure a delta time session window.
|
2494
|
+
# @return [Types::DeltaTimeSessionWindowConfiguration]
|
2495
|
+
#
|
2496
|
+
class LateDataRuleConfiguration < Struct.new(
|
2497
|
+
:delta_time_session_window_configuration)
|
2498
|
+
SENSITIVE = []
|
2499
|
+
include Aws::Structure
|
2500
|
+
end
|
2501
|
+
|
2169
2502
|
# The command caused an internal limit to be exceeded.
|
2170
2503
|
#
|
2171
2504
|
# @!attribute [rw] message
|
@@ -2203,7 +2536,7 @@ module Aws::IoTAnalytics
|
|
2203
2536
|
end
|
2204
2537
|
|
2205
2538
|
# @!attribute [rw] channel_summaries
|
2206
|
-
# A list of
|
2539
|
+
# A list of `ChannelSummary` objects.
|
2207
2540
|
# @return [Array<Types::ChannelSummary>]
|
2208
2541
|
#
|
2209
2542
|
# @!attribute [rw] next_token
|
@@ -2245,13 +2578,13 @@ module Aws::IoTAnalytics
|
|
2245
2578
|
# @!attribute [rw] scheduled_on_or_after
|
2246
2579
|
# A filter to limit results to those data set contents whose creation
|
2247
2580
|
# is scheduled on or after the given time. See the field
|
2248
|
-
# `triggers.schedule` in the CreateDataset request. (timestamp)
|
2581
|
+
# `triggers.schedule` in the `CreateDataset` request. (timestamp)
|
2249
2582
|
# @return [Time]
|
2250
2583
|
#
|
2251
2584
|
# @!attribute [rw] scheduled_before
|
2252
2585
|
# A filter to limit results to those data set contents whose creation
|
2253
2586
|
# is scheduled before the given time. See the field
|
2254
|
-
# `triggers.schedule` in the CreateDataset request. (timestamp)
|
2587
|
+
# `triggers.schedule` in the `CreateDataset` request. (timestamp)
|
2255
2588
|
# @return [Time]
|
2256
2589
|
#
|
2257
2590
|
class ListDatasetContentsRequest < Struct.new(
|
@@ -2306,7 +2639,7 @@ module Aws::IoTAnalytics
|
|
2306
2639
|
end
|
2307
2640
|
|
2308
2641
|
# @!attribute [rw] dataset_summaries
|
2309
|
-
# A list of
|
2642
|
+
# A list of `DatasetSummary` objects.
|
2310
2643
|
# @return [Array<Types::DatasetSummary>]
|
2311
2644
|
#
|
2312
2645
|
# @!attribute [rw] next_token
|
@@ -2347,7 +2680,7 @@ module Aws::IoTAnalytics
|
|
2347
2680
|
end
|
2348
2681
|
|
2349
2682
|
# @!attribute [rw] datastore_summaries
|
2350
|
-
# A list of
|
2683
|
+
# A list of `DatastoreSummary` objects.
|
2351
2684
|
# @return [Array<Types::DatastoreSummary>]
|
2352
2685
|
#
|
2353
2686
|
# @!attribute [rw] next_token
|
@@ -2388,7 +2721,7 @@ module Aws::IoTAnalytics
|
|
2388
2721
|
end
|
2389
2722
|
|
2390
2723
|
# @!attribute [rw] pipeline_summaries
|
2391
|
-
# A list of
|
2724
|
+
# A list of `PipelineSummary` objects.
|
2392
2725
|
# @return [Array<Types::PipelineSummary>]
|
2393
2726
|
#
|
2394
2727
|
# @!attribute [rw] next_token
|
@@ -2421,7 +2754,7 @@ module Aws::IoTAnalytics
|
|
2421
2754
|
end
|
2422
2755
|
|
2423
2756
|
# @!attribute [rw] tags
|
2424
|
-
# The tags (metadata)
|
2757
|
+
# The tags (metadata) that you have assigned to the resource.
|
2425
2758
|
# @return [Array<Types::Tag>]
|
2426
2759
|
#
|
2427
2760
|
class ListTagsForResourceResponse < Struct.new(
|
@@ -2447,7 +2780,7 @@ module Aws::IoTAnalytics
|
|
2447
2780
|
# @return [String]
|
2448
2781
|
#
|
2449
2782
|
# @!attribute [rw] level
|
2450
|
-
# The logging level. Currently, only
|
2783
|
+
# The logging level. Currently, only ERROR is supported.
|
2451
2784
|
# @return [String]
|
2452
2785
|
#
|
2453
2786
|
# @!attribute [rw] enabled
|
@@ -2476,7 +2809,7 @@ module Aws::IoTAnalytics
|
|
2476
2809
|
# }
|
2477
2810
|
#
|
2478
2811
|
# @!attribute [rw] name
|
2479
|
-
# The name of the
|
2812
|
+
# The name of the math activity.
|
2480
2813
|
# @return [String]
|
2481
2814
|
#
|
2482
2815
|
# @!attribute [rw] attribute
|
@@ -2513,14 +2846,14 @@ module Aws::IoTAnalytics
|
|
2513
2846
|
# }
|
2514
2847
|
#
|
2515
2848
|
# @!attribute [rw] message_id
|
2516
|
-
# The ID you
|
2849
|
+
# The ID you want to assign to the message. Each `messageId` must be
|
2517
2850
|
# unique within each batch sent.
|
2518
2851
|
# @return [String]
|
2519
2852
|
#
|
2520
2853
|
# @!attribute [rw] payload
|
2521
|
-
# The payload of the message. This
|
2522
|
-
#
|
2523
|
-
# must decode it by means of a pipeline activity
|
2854
|
+
# The payload of the message. This can be a JSON string or a
|
2855
|
+
# base64-encoded string representing binary data, in which case you
|
2856
|
+
# must decode it by means of a pipeline activity.
|
2524
2857
|
# @return [String]
|
2525
2858
|
#
|
2526
2859
|
class Message < Struct.new(
|
@@ -2541,7 +2874,7 @@ module Aws::IoTAnalytics
|
|
2541
2874
|
# }
|
2542
2875
|
#
|
2543
2876
|
# @!attribute [rw] file_name
|
2544
|
-
# The URI of the location where
|
2877
|
+
# The URI of the location where dataset contents are stored, usually
|
2545
2878
|
# the URI of a file in an S3 bucket.
|
2546
2879
|
# @return [String]
|
2547
2880
|
#
|
@@ -2551,6 +2884,32 @@ module Aws::IoTAnalytics
|
|
2551
2884
|
include Aws::Structure
|
2552
2885
|
end
|
2553
2886
|
|
2887
|
+
# Contains the configuration information of the Parquet format.
|
2888
|
+
#
|
2889
|
+
# @note When making an API call, you may pass ParquetConfiguration
|
2890
|
+
# data as a hash:
|
2891
|
+
#
|
2892
|
+
# {
|
2893
|
+
# schema_definition: {
|
2894
|
+
# columns: [
|
2895
|
+
# {
|
2896
|
+
# name: "ColumnName", # required
|
2897
|
+
# type: "ColumnDataType", # required
|
2898
|
+
# },
|
2899
|
+
# ],
|
2900
|
+
# },
|
2901
|
+
# }
|
2902
|
+
#
|
2903
|
+
# @!attribute [rw] schema_definition
|
2904
|
+
# Information needed to define a schema.
|
2905
|
+
# @return [Types::SchemaDefinition]
|
2906
|
+
#
|
2907
|
+
class ParquetConfiguration < Struct.new(
|
2908
|
+
:schema_definition)
|
2909
|
+
SENSITIVE = []
|
2910
|
+
include Aws::Structure
|
2911
|
+
end
|
2912
|
+
|
2554
2913
|
# Contains information about a pipeline.
|
2555
2914
|
#
|
2556
2915
|
# @!attribute [rw] name
|
@@ -2692,7 +3051,7 @@ module Aws::IoTAnalytics
|
|
2692
3051
|
# @return [Types::DeviceRegistryEnrichActivity]
|
2693
3052
|
#
|
2694
3053
|
# @!attribute [rw] device_shadow_enrich
|
2695
|
-
# Adds information from the AWS IoT Device
|
3054
|
+
# Adds information from the AWS IoT Device Shadow service to a
|
2696
3055
|
# message.
|
2697
3056
|
# @return [Types::DeviceShadowEnrichActivity]
|
2698
3057
|
#
|
@@ -2759,8 +3118,8 @@ module Aws::IoTAnalytics
|
|
2759
3118
|
include Aws::Structure
|
2760
3119
|
end
|
2761
3120
|
|
2762
|
-
# Information
|
2763
|
-
# according to the
|
3121
|
+
# Information that is used to filter message data, to segregate it
|
3122
|
+
# according to the timeframe in which it arrives.
|
2764
3123
|
#
|
2765
3124
|
# @note When making an API call, you may pass QueryFilter
|
2766
3125
|
# data as a hash:
|
@@ -2795,7 +3154,7 @@ module Aws::IoTAnalytics
|
|
2795
3154
|
# }
|
2796
3155
|
#
|
2797
3156
|
# @!attribute [rw] name
|
2798
|
-
# The name of the
|
3157
|
+
# The name of the `removeAttributes` activity.
|
2799
3158
|
# @return [String]
|
2800
3159
|
#
|
2801
3160
|
# @!attribute [rw] attributes
|
@@ -2817,7 +3176,7 @@ module Aws::IoTAnalytics
|
|
2817
3176
|
# Information about pipeline reprocessing.
|
2818
3177
|
#
|
2819
3178
|
# @!attribute [rw] id
|
2820
|
-
# The
|
3179
|
+
# The `reprocessingId` returned by `StartPipelineReprocessing`.
|
2821
3180
|
# @return [String]
|
2822
3181
|
#
|
2823
3182
|
# @!attribute [rw] status
|
@@ -2858,7 +3217,7 @@ module Aws::IoTAnalytics
|
|
2858
3217
|
end
|
2859
3218
|
|
2860
3219
|
# The configuration of the resource used to execute the
|
2861
|
-
#
|
3220
|
+
# `containerAction`.
|
2862
3221
|
#
|
2863
3222
|
# @note When making an API call, you may pass ResourceConfiguration
|
2864
3223
|
# data as a hash:
|
@@ -2870,13 +3229,13 @@ module Aws::IoTAnalytics
|
|
2870
3229
|
#
|
2871
3230
|
# @!attribute [rw] compute_type
|
2872
3231
|
# The type of the compute resource used to execute the
|
2873
|
-
#
|
2874
|
-
#
|
3232
|
+
# `containerAction`. Possible values are: `ACU_1` (vCPU=4, memory=16
|
3233
|
+
# GiB) or `ACU_2` (vCPU=8, memory=32 GiB).
|
2875
3234
|
# @return [String]
|
2876
3235
|
#
|
2877
3236
|
# @!attribute [rw] volume_size_in_gb
|
2878
|
-
# The size
|
2879
|
-
# instance used to execute the
|
3237
|
+
# The size, in GB, of the persistent storage available to the resource
|
3238
|
+
# instance used to execute the `containerAction` (min: 1, max: 50).
|
2880
3239
|
# @return [Integer]
|
2881
3240
|
#
|
2882
3241
|
class ResourceConfiguration < Struct.new(
|
@@ -2912,7 +3271,7 @@ module Aws::IoTAnalytics
|
|
2912
3271
|
# @return [Boolean]
|
2913
3272
|
#
|
2914
3273
|
# @!attribute [rw] number_of_days
|
2915
|
-
# The number of days that message data is kept. The
|
3274
|
+
# The number of days that message data is kept. The `unlimited`
|
2916
3275
|
# parameter must be false.
|
2917
3276
|
# @return [Integer]
|
2918
3277
|
#
|
@@ -2990,12 +3349,12 @@ module Aws::IoTAnalytics
|
|
2990
3349
|
# }
|
2991
3350
|
#
|
2992
3351
|
# @!attribute [rw] pipeline_activity
|
2993
|
-
# The pipeline activity that is run. This must not be a
|
2994
|
-
# activity or a
|
2995
|
-
#
|
2996
|
-
#
|
2997
|
-
#
|
2998
|
-
#
|
3352
|
+
# The pipeline activity that is run. This must not be a channel
|
3353
|
+
# activity or a datastore activity because these activities are used
|
3354
|
+
# in a pipeline only to load the original message and to store the
|
3355
|
+
# (possibly) transformed message. If a lambda activity is specified,
|
3356
|
+
# only short-running Lambda functions (those with a timeout of less
|
3357
|
+
# than 30 seconds or less) can be used.
|
2999
3358
|
# @return [Types::PipelineActivity]
|
3000
3359
|
#
|
3001
3360
|
# @!attribute [rw] payloads
|
@@ -3027,8 +3386,8 @@ module Aws::IoTAnalytics
|
|
3027
3386
|
include Aws::Structure
|
3028
3387
|
end
|
3029
3388
|
|
3030
|
-
# Configuration information for delivery of
|
3031
|
-
# S3.
|
3389
|
+
# Configuration information for delivery of dataset contents to Amazon
|
3390
|
+
# Simple Storage Service (Amazon S3).
|
3032
3391
|
#
|
3033
3392
|
# @note When making an API call, you may pass S3DestinationConfiguration
|
3034
3393
|
# data as a hash:
|
@@ -3044,28 +3403,44 @@ module Aws::IoTAnalytics
|
|
3044
3403
|
# }
|
3045
3404
|
#
|
3046
3405
|
# @!attribute [rw] bucket
|
3047
|
-
# The name of the
|
3048
|
-
# delivered.
|
3406
|
+
# The name of the S3 bucket to which dataset contents are delivered.
|
3049
3407
|
# @return [String]
|
3050
3408
|
#
|
3051
3409
|
# @!attribute [rw] key
|
3052
|
-
# The key of the
|
3053
|
-
#
|
3054
|
-
#
|
3055
|
-
#
|
3056
|
-
#
|
3057
|
-
#
|
3058
|
-
# the
|
3059
|
-
#
|
3410
|
+
# The key of the dataset contents object in an S3 bucket. Each object
|
3411
|
+
# has a key that is a unique identifier. Each object has exactly one
|
3412
|
+
# key.
|
3413
|
+
#
|
3414
|
+
# You can create a unique key with the following options:
|
3415
|
+
#
|
3416
|
+
# * Use `!\{iotanalytics:scheduleTime\}` to insert the time of a
|
3417
|
+
# scheduled SQL query run.
|
3418
|
+
#
|
3419
|
+
# * Use `!\{iotanalytics:versionId\}` to insert a unique hash that
|
3420
|
+
# identifies a dataset content.
|
3421
|
+
#
|
3422
|
+
# * Use `!\{iotanalytics:creationTime\}` to insert the creation time
|
3423
|
+
# of a dataset content.
|
3424
|
+
#
|
3425
|
+
# The following example creates a unique key for a CSV file:
|
3426
|
+
# `dataset/mydataset/!\{iotanalytics:scheduleTime\}/!\{iotanalytics:versionId\}.csv`
|
3427
|
+
#
|
3428
|
+
# <note markdown="1"> If you don't use `!\{iotanalytics:versionId\}` to specify the key,
|
3429
|
+
# you might get duplicate keys. For example, you might have two
|
3430
|
+
# dataset contents with the same `scheduleTime` but different
|
3431
|
+
# `versionId`s. This means that one dataset content overwrites the
|
3432
|
+
# other.
|
3433
|
+
#
|
3434
|
+
# </note>
|
3060
3435
|
# @return [String]
|
3061
3436
|
#
|
3062
3437
|
# @!attribute [rw] glue_configuration
|
3063
|
-
# Configuration information for coordination with
|
3064
|
-
#
|
3438
|
+
# Configuration information for coordination with AWS Glue, a fully
|
3439
|
+
# managed extract, transform and load (ETL) service.
|
3065
3440
|
# @return [Types::GlueConfiguration]
|
3066
3441
|
#
|
3067
3442
|
# @!attribute [rw] role_arn
|
3068
|
-
# The ARN of the role
|
3443
|
+
# The ARN of the role that grants AWS IoT Analytics permission to
|
3069
3444
|
# interact with your Amazon S3 and AWS Glue resources.
|
3070
3445
|
# @return [String]
|
3071
3446
|
#
|
@@ -3093,7 +3468,7 @@ module Aws::IoTAnalytics
|
|
3093
3468
|
# @return [String]
|
3094
3469
|
#
|
3095
3470
|
# @!attribute [rw] max_messages
|
3096
|
-
# The number of sample messages to be retrieved. The limit is 10
|
3471
|
+
# The number of sample messages to be retrieved. The limit is 10. The
|
3097
3472
|
# default is also 10.
|
3098
3473
|
# @return [Integer]
|
3099
3474
|
#
|
@@ -3137,8 +3512,8 @@ module Aws::IoTAnalytics
|
|
3137
3512
|
#
|
3138
3513
|
# @!attribute [rw] expression
|
3139
3514
|
# The expression that defines when to trigger an update. For more
|
3140
|
-
# information, see [
|
3141
|
-
# CloudWatch Events User Guide
|
3515
|
+
# information, see [Schedule Expressions for Rules][1] in the *Amazon
|
3516
|
+
# CloudWatch Events User Guide*.
|
3142
3517
|
#
|
3143
3518
|
#
|
3144
3519
|
#
|
@@ -3151,6 +3526,33 @@ module Aws::IoTAnalytics
|
|
3151
3526
|
include Aws::Structure
|
3152
3527
|
end
|
3153
3528
|
|
3529
|
+
# Information needed to define a schema.
|
3530
|
+
#
|
3531
|
+
# @note When making an API call, you may pass SchemaDefinition
|
3532
|
+
# data as a hash:
|
3533
|
+
#
|
3534
|
+
# {
|
3535
|
+
# columns: [
|
3536
|
+
# {
|
3537
|
+
# name: "ColumnName", # required
|
3538
|
+
# type: "ColumnDataType", # required
|
3539
|
+
# },
|
3540
|
+
# ],
|
3541
|
+
# }
|
3542
|
+
#
|
3543
|
+
# @!attribute [rw] columns
|
3544
|
+
# Specifies one or more columns that store your data.
|
3545
|
+
#
|
3546
|
+
# Each schema can have up to 100 columns. Each column can have up to
|
3547
|
+
# 100 nested types
|
3548
|
+
# @return [Array<Types::Column>]
|
3549
|
+
#
|
3550
|
+
class SchemaDefinition < Struct.new(
|
3551
|
+
:columns)
|
3552
|
+
SENSITIVE = []
|
3553
|
+
include Aws::Structure
|
3554
|
+
end
|
3555
|
+
|
3154
3556
|
# Creates a new message using only the specified attributes from the
|
3155
3557
|
# original message.
|
3156
3558
|
#
|
@@ -3164,7 +3566,7 @@ module Aws::IoTAnalytics
|
|
3164
3566
|
# }
|
3165
3567
|
#
|
3166
3568
|
# @!attribute [rw] name
|
3167
|
-
# The name of the
|
3569
|
+
# The name of the `selectAttributes` activity.
|
3168
3570
|
# @return [String]
|
3169
3571
|
#
|
3170
3572
|
# @!attribute [rw] attributes
|
@@ -3183,30 +3585,29 @@ module Aws::IoTAnalytics
|
|
3183
3585
|
include Aws::Structure
|
3184
3586
|
end
|
3185
3587
|
|
3186
|
-
# Use this to store channel data in an S3 bucket managed by
|
3187
|
-
# Analytics
|
3188
|
-
# S3 storage
|
3588
|
+
# Use this to store channel data in an S3 bucket managed by AWS IoT
|
3589
|
+
# Analytics. You cannot change the choice of service-managed or
|
3590
|
+
# customer-managed S3 storage after the channel is created.
|
3189
3591
|
#
|
3190
3592
|
# @api private
|
3191
3593
|
#
|
3192
3594
|
class ServiceManagedChannelS3Storage < Aws::EmptyStructure; end
|
3193
3595
|
|
3194
|
-
# Used to store channel data in an S3 bucket managed by
|
3195
|
-
# Analytics
|
3596
|
+
# Used to store channel data in an S3 bucket managed by AWS IoT
|
3597
|
+
# Analytics.
|
3196
3598
|
#
|
3197
3599
|
class ServiceManagedChannelS3StorageSummary < Aws::EmptyStructure; end
|
3198
3600
|
|
3199
|
-
# Use this to store data store data in an S3 bucket managed by
|
3200
|
-
#
|
3201
|
-
# customer-managed S3 storage
|
3202
|
-
# data store.
|
3601
|
+
# Use this to store data store data in an S3 bucket managed by AWS IoT
|
3602
|
+
# Analytics. You cannot change the choice of service-managed or
|
3603
|
+
# customer-managed S3 storage after the data store is created.
|
3203
3604
|
#
|
3204
3605
|
# @api private
|
3205
3606
|
#
|
3206
3607
|
class ServiceManagedDatastoreS3Storage < Aws::EmptyStructure; end
|
3207
3608
|
|
3208
|
-
# Used to store data store data in an S3 bucket managed by
|
3209
|
-
# Analytics
|
3609
|
+
# Used to store data store data in an S3 bucket managed by AWS IoT
|
3610
|
+
# Analytics.
|
3210
3611
|
#
|
3211
3612
|
class ServiceManagedDatastoreS3StorageSummary < Aws::EmptyStructure; end
|
3212
3613
|
|
@@ -3243,7 +3644,7 @@ module Aws::IoTAnalytics
|
|
3243
3644
|
# @return [String]
|
3244
3645
|
#
|
3245
3646
|
# @!attribute [rw] filters
|
3246
|
-
#
|
3647
|
+
# Prefilters applied to message data.
|
3247
3648
|
# @return [Array<Types::QueryFilter>]
|
3248
3649
|
#
|
3249
3650
|
class SqlQueryDatasetAction < Struct.new(
|
@@ -3260,6 +3661,9 @@ module Aws::IoTAnalytics
|
|
3260
3661
|
# pipeline_name: "PipelineName", # required
|
3261
3662
|
# start_time: Time.now,
|
3262
3663
|
# end_time: Time.now,
|
3664
|
+
# channel_messages: {
|
3665
|
+
# s3_paths: ["S3PathChannelMessage"],
|
3666
|
+
# },
|
3263
3667
|
# }
|
3264
3668
|
#
|
3265
3669
|
# @!attribute [rw] pipeline_name
|
@@ -3268,16 +3672,31 @@ module Aws::IoTAnalytics
|
|
3268
3672
|
#
|
3269
3673
|
# @!attribute [rw] start_time
|
3270
3674
|
# The start time (inclusive) of raw message data that is reprocessed.
|
3675
|
+
#
|
3676
|
+
# If you specify a value for the `startTime` parameter, you must not
|
3677
|
+
# use the `channelMessages` object.
|
3271
3678
|
# @return [Time]
|
3272
3679
|
#
|
3273
3680
|
# @!attribute [rw] end_time
|
3274
3681
|
# The end time (exclusive) of raw message data that is reprocessed.
|
3682
|
+
#
|
3683
|
+
# If you specify a value for the `endTime` parameter, you must not use
|
3684
|
+
# the `channelMessages` object.
|
3275
3685
|
# @return [Time]
|
3276
3686
|
#
|
3687
|
+
# @!attribute [rw] channel_messages
|
3688
|
+
# Specifies one or more sets of channel messages that you want to
|
3689
|
+
# reprocess.
|
3690
|
+
#
|
3691
|
+
# If you use the `channelMessages` object, you must not specify a
|
3692
|
+
# value for `startTime` and `endTime`.
|
3693
|
+
# @return [Types::ChannelMessages]
|
3694
|
+
#
|
3277
3695
|
class StartPipelineReprocessingRequest < Struct.new(
|
3278
3696
|
:pipeline_name,
|
3279
3697
|
:start_time,
|
3280
|
-
:end_time
|
3698
|
+
:end_time,
|
3699
|
+
:channel_messages)
|
3281
3700
|
SENSITIVE = []
|
3282
3701
|
include Aws::Structure
|
3283
3702
|
end
|
@@ -3292,7 +3711,7 @@ module Aws::IoTAnalytics
|
|
3292
3711
|
include Aws::Structure
|
3293
3712
|
end
|
3294
3713
|
|
3295
|
-
# A set of key
|
3714
|
+
# A set of key-value pairs that are used to manage the resource.
|
3296
3715
|
#
|
3297
3716
|
# @note When making an API call, you may pass Tag
|
3298
3717
|
# data as a hash:
|
@@ -3358,8 +3777,8 @@ module Aws::IoTAnalytics
|
|
3358
3777
|
include Aws::Structure
|
3359
3778
|
end
|
3360
3779
|
|
3361
|
-
# Information about the
|
3362
|
-
# new
|
3780
|
+
# Information about the dataset whose content generation triggers the
|
3781
|
+
# new dataset content generation.
|
3363
3782
|
#
|
3364
3783
|
# @note When making an API call, you may pass TriggeringDataset
|
3365
3784
|
# data as a hash:
|
@@ -3369,8 +3788,8 @@ module Aws::IoTAnalytics
|
|
3369
3788
|
# }
|
3370
3789
|
#
|
3371
3790
|
# @!attribute [rw] name
|
3372
|
-
# The name of the
|
3373
|
-
#
|
3791
|
+
# The name of the dataset whose content generation triggers the new
|
3792
|
+
# dataset content generation.
|
3374
3793
|
# @return [String]
|
3375
3794
|
#
|
3376
3795
|
class TriggeringDataset < Struct.new(
|
@@ -3429,10 +3848,10 @@ module Aws::IoTAnalytics
|
|
3429
3848
|
# @return [String]
|
3430
3849
|
#
|
3431
3850
|
# @!attribute [rw] channel_storage
|
3432
|
-
# Where channel data is stored. You
|
3433
|
-
#
|
3434
|
-
#
|
3435
|
-
#
|
3851
|
+
# Where channel data is stored. You can choose one of
|
3852
|
+
# `serviceManagedS3` or `customerManagedS3` storage. If not specified,
|
3853
|
+
# the default is `serviceManagedS3`. You cannot change this storage
|
3854
|
+
# option after the channel is created.
|
3436
3855
|
# @return [Types::ChannelStorage]
|
3437
3856
|
#
|
3438
3857
|
# @!attribute [rw] retention_period
|
@@ -3529,6 +3948,16 @@ module Aws::IoTAnalytics
|
|
3529
3948
|
# unlimited: false,
|
3530
3949
|
# max_versions: 1,
|
3531
3950
|
# },
|
3951
|
+
# late_data_rules: [
|
3952
|
+
# {
|
3953
|
+
# rule_name: "LateDataRuleName",
|
3954
|
+
# rule_configuration: { # required
|
3955
|
+
# delta_time_session_window_configuration: {
|
3956
|
+
# timeout_in_minutes: 1, # required
|
3957
|
+
# },
|
3958
|
+
# },
|
3959
|
+
# },
|
3960
|
+
# ],
|
3532
3961
|
# }
|
3533
3962
|
#
|
3534
3963
|
# @!attribute [rw] dataset_name
|
@@ -3536,39 +3965,54 @@ module Aws::IoTAnalytics
|
|
3536
3965
|
# @return [String]
|
3537
3966
|
#
|
3538
3967
|
# @!attribute [rw] actions
|
3539
|
-
# A list of
|
3968
|
+
# A list of `DatasetAction` objects.
|
3540
3969
|
# @return [Array<Types::DatasetAction>]
|
3541
3970
|
#
|
3542
3971
|
# @!attribute [rw] triggers
|
3543
|
-
# A list of
|
3544
|
-
# contain up to five
|
3972
|
+
# A list of `DatasetTrigger` objects. The list can be empty or can
|
3973
|
+
# contain up to five `DatasetTrigger` objects.
|
3545
3974
|
# @return [Array<Types::DatasetTrigger>]
|
3546
3975
|
#
|
3547
3976
|
# @!attribute [rw] content_delivery_rules
|
3548
|
-
# When
|
3977
|
+
# When dataset contents are created, they are delivered to
|
3549
3978
|
# destinations specified here.
|
3550
3979
|
# @return [Array<Types::DatasetContentDeliveryRule>]
|
3551
3980
|
#
|
3552
3981
|
# @!attribute [rw] retention_period
|
3553
|
-
# How long, in days,
|
3982
|
+
# How long, in days, dataset contents are kept for the dataset.
|
3554
3983
|
# @return [Types::RetentionPeriod]
|
3555
3984
|
#
|
3556
3985
|
# @!attribute [rw] versioning_configuration
|
3557
|
-
#
|
3986
|
+
# Optional. How many versions of dataset contents are kept. If not
|
3558
3987
|
# specified or set to null, only the latest version plus the latest
|
3559
3988
|
# succeeded version (if they are different) are kept for the time
|
3560
|
-
# period specified by the
|
3561
|
-
# information, see
|
3562
|
-
#
|
3989
|
+
# period specified by the `retentionPeriod` parameter. For more
|
3990
|
+
# information, see [Keeping Multiple Versions of AWS IoT Analytics
|
3991
|
+
# Data Sets][1] in the *AWS IoT Analytics User Guide*.
|
3992
|
+
#
|
3993
|
+
#
|
3994
|
+
#
|
3995
|
+
# [1]: https://docs.aws.amazon.com/iotanalytics/latest/userguide/getting-started.html#aws-iot-analytics-dataset-versions
|
3563
3996
|
# @return [Types::VersioningConfiguration]
|
3564
3997
|
#
|
3998
|
+
# @!attribute [rw] late_data_rules
|
3999
|
+
# A list of data rules that send notifications to Amazon CloudWatch,
|
4000
|
+
# when data arrives late. To specify `lateDataRules`, the dataset must
|
4001
|
+
# use a [DeltaTimer][1] filter.
|
4002
|
+
#
|
4003
|
+
#
|
4004
|
+
#
|
4005
|
+
# [1]: https://docs.aws.amazon.com/iotanalytics/latest/APIReference/API_DeltaTime.html
|
4006
|
+
# @return [Array<Types::LateDataRule>]
|
4007
|
+
#
|
3565
4008
|
class UpdateDatasetRequest < Struct.new(
|
3566
4009
|
:dataset_name,
|
3567
4010
|
:actions,
|
3568
4011
|
:triggers,
|
3569
4012
|
:content_delivery_rules,
|
3570
4013
|
:retention_period,
|
3571
|
-
:versioning_configuration
|
4014
|
+
:versioning_configuration,
|
4015
|
+
:late_data_rules)
|
3572
4016
|
SENSITIVE = []
|
3573
4017
|
include Aws::Structure
|
3574
4018
|
end
|
@@ -3591,6 +4035,20 @@ module Aws::IoTAnalytics
|
|
3591
4035
|
# role_arn: "RoleArn", # required
|
3592
4036
|
# },
|
3593
4037
|
# },
|
4038
|
+
# file_format_configuration: {
|
4039
|
+
# json_configuration: {
|
4040
|
+
# },
|
4041
|
+
# parquet_configuration: {
|
4042
|
+
# schema_definition: {
|
4043
|
+
# columns: [
|
4044
|
+
# {
|
4045
|
+
# name: "ColumnName", # required
|
4046
|
+
# type: "ColumnDataType", # required
|
4047
|
+
# },
|
4048
|
+
# ],
|
4049
|
+
# },
|
4050
|
+
# },
|
4051
|
+
# },
|
3594
4052
|
# }
|
3595
4053
|
#
|
3596
4054
|
# @!attribute [rw] datastore_name
|
@@ -3604,16 +4062,30 @@ module Aws::IoTAnalytics
|
|
3604
4062
|
# @return [Types::RetentionPeriod]
|
3605
4063
|
#
|
3606
4064
|
# @!attribute [rw] datastore_storage
|
3607
|
-
# Where data store data is stored. You
|
3608
|
-
#
|
3609
|
-
#
|
3610
|
-
#
|
4065
|
+
# Where data store data is stored. You can choose one of
|
4066
|
+
# `serviceManagedS3` or `customerManagedS3` storage. If not specified,
|
4067
|
+
# the default is`serviceManagedS3`. You cannot change this storage
|
4068
|
+
# option after the data store is created.
|
3611
4069
|
# @return [Types::DatastoreStorage]
|
3612
4070
|
#
|
4071
|
+
# @!attribute [rw] file_format_configuration
|
4072
|
+
# Contains the configuration information of file formats. AWS IoT
|
4073
|
+
# Analytics data stores support JSON and [Parquet][1].
|
4074
|
+
#
|
4075
|
+
# The default file format is JSON. You can specify only one format.
|
4076
|
+
#
|
4077
|
+
# You can't change the file format after you create the data store.
|
4078
|
+
#
|
4079
|
+
#
|
4080
|
+
#
|
4081
|
+
# [1]: https://parquet.apache.org/
|
4082
|
+
# @return [Types::FileFormatConfiguration]
|
4083
|
+
#
|
3613
4084
|
class UpdateDatastoreRequest < Struct.new(
|
3614
4085
|
:datastore_name,
|
3615
4086
|
:retention_period,
|
3616
|
-
:datastore_storage
|
4087
|
+
:datastore_storage,
|
4088
|
+
:file_format_configuration)
|
3617
4089
|
SENSITIVE = []
|
3618
4090
|
include Aws::Structure
|
3619
4091
|
end
|
@@ -3691,16 +4163,16 @@ module Aws::IoTAnalytics
|
|
3691
4163
|
# @return [String]
|
3692
4164
|
#
|
3693
4165
|
# @!attribute [rw] pipeline_activities
|
3694
|
-
# A list of
|
4166
|
+
# A list of `PipelineActivity` objects. Activities perform
|
3695
4167
|
# transformations on your messages, such as removing, renaming or
|
3696
4168
|
# adding message attributes; filtering messages based on attribute
|
3697
4169
|
# values; invoking your Lambda functions on messages for advanced
|
3698
4170
|
# processing; or performing mathematical transformations to normalize
|
3699
4171
|
# device data.
|
3700
4172
|
#
|
3701
|
-
# The list can be 2-25
|
4173
|
+
# The list can be 2-25 `PipelineActivity` objects and must contain
|
3702
4174
|
# both a `channel` and a `datastore` activity. Each entry in the list
|
3703
|
-
# must contain only one activity
|
4175
|
+
# must contain only one activity. For example:
|
3704
4176
|
#
|
3705
4177
|
# `pipelineActivities = [ \{ "channel": \{ ... \} \}, \{ "lambda": \{
|
3706
4178
|
# ... \} \}, ... ]`
|
@@ -3713,10 +4185,9 @@ module Aws::IoTAnalytics
|
|
3713
4185
|
include Aws::Structure
|
3714
4186
|
end
|
3715
4187
|
|
3716
|
-
# An instance of a variable to be passed to the
|
4188
|
+
# An instance of a variable to be passed to the `containerAction`
|
3717
4189
|
# execution. Each variable must have a name and a value given by one of
|
3718
|
-
#
|
3719
|
-
# "outputFileUriValue".
|
4190
|
+
# `stringValue`, `datasetContentVersionValue`, or `outputFileUriValue`.
|
3720
4191
|
#
|
3721
4192
|
# @note When making an API call, you may pass Variable
|
3722
4193
|
# data as a hash:
|
@@ -3746,7 +4217,7 @@ module Aws::IoTAnalytics
|
|
3746
4217
|
# @return [Float]
|
3747
4218
|
#
|
3748
4219
|
# @!attribute [rw] dataset_content_version_value
|
3749
|
-
# The value of the variable as a structure that specifies a
|
4220
|
+
# The value of the variable as a structure that specifies a dataset
|
3750
4221
|
# content version.
|
3751
4222
|
# @return [Types::DatasetContentVersionValue]
|
3752
4223
|
#
|
@@ -3765,7 +4236,7 @@ module Aws::IoTAnalytics
|
|
3765
4236
|
include Aws::Structure
|
3766
4237
|
end
|
3767
4238
|
|
3768
|
-
# Information about the versioning of
|
4239
|
+
# Information about the versioning of dataset contents.
|
3769
4240
|
#
|
3770
4241
|
# @note When making an API call, you may pass VersioningConfiguration
|
3771
4242
|
# data as a hash:
|
@@ -3776,12 +4247,12 @@ module Aws::IoTAnalytics
|
|
3776
4247
|
# }
|
3777
4248
|
#
|
3778
4249
|
# @!attribute [rw] unlimited
|
3779
|
-
# If true, unlimited versions of
|
4250
|
+
# If true, unlimited versions of dataset contents are kept.
|
3780
4251
|
# @return [Boolean]
|
3781
4252
|
#
|
3782
4253
|
# @!attribute [rw] max_versions
|
3783
|
-
# How many versions of
|
3784
|
-
#
|
4254
|
+
# How many versions of dataset contents are kept. The `unlimited`
|
4255
|
+
# parameter must be `false`.
|
3785
4256
|
# @return [Integer]
|
3786
4257
|
#
|
3787
4258
|
class VersioningConfiguration < Struct.new(
|