aws-sdk-iotanalytics 1.34.0 → 1.35.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/aws-sdk-iotanalytics.rb +1 -1
- data/lib/aws-sdk-iotanalytics/client.rb +155 -89
- data/lib/aws-sdk-iotanalytics/client_api.rb +26 -0
- data/lib/aws-sdk-iotanalytics/types.rb +541 -316
- metadata +2 -2
@@ -94,6 +94,7 @@ module Aws::IoTAnalytics
|
|
94
94
|
DeleteDatastoreRequest = Shapes::StructureShape.new(name: 'DeleteDatastoreRequest')
|
95
95
|
DeletePipelineRequest = Shapes::StructureShape.new(name: 'DeletePipelineRequest')
|
96
96
|
DeltaTime = Shapes::StructureShape.new(name: 'DeltaTime')
|
97
|
+
DeltaTimeSessionWindowConfiguration = Shapes::StructureShape.new(name: 'DeltaTimeSessionWindowConfiguration')
|
97
98
|
DescribeChannelRequest = Shapes::StructureShape.new(name: 'DescribeChannelRequest')
|
98
99
|
DescribeChannelResponse = Shapes::StructureShape.new(name: 'DescribeChannelResponse')
|
99
100
|
DescribeDatasetRequest = Shapes::StructureShape.new(name: 'DescribeDatasetRequest')
|
@@ -127,6 +128,10 @@ module Aws::IoTAnalytics
|
|
127
128
|
IotEventsInputName = Shapes::StringShape.new(name: 'IotEventsInputName')
|
128
129
|
LambdaActivity = Shapes::StructureShape.new(name: 'LambdaActivity')
|
129
130
|
LambdaName = Shapes::StringShape.new(name: 'LambdaName')
|
131
|
+
LateDataRule = Shapes::StructureShape.new(name: 'LateDataRule')
|
132
|
+
LateDataRuleConfiguration = Shapes::StructureShape.new(name: 'LateDataRuleConfiguration')
|
133
|
+
LateDataRuleName = Shapes::StringShape.new(name: 'LateDataRuleName')
|
134
|
+
LateDataRules = Shapes::ListShape.new(name: 'LateDataRules')
|
130
135
|
LimitExceededException = Shapes::StructureShape.new(name: 'LimitExceededException')
|
131
136
|
ListChannelsRequest = Shapes::StructureShape.new(name: 'ListChannelsRequest')
|
132
137
|
ListChannelsResponse = Shapes::StructureShape.new(name: 'ListChannelsResponse')
|
@@ -196,6 +201,7 @@ module Aws::IoTAnalytics
|
|
196
201
|
ServiceManagedDatastoreS3Storage = Shapes::StructureShape.new(name: 'ServiceManagedDatastoreS3Storage')
|
197
202
|
ServiceManagedDatastoreS3StorageSummary = Shapes::StructureShape.new(name: 'ServiceManagedDatastoreS3StorageSummary')
|
198
203
|
ServiceUnavailableException = Shapes::StructureShape.new(name: 'ServiceUnavailableException')
|
204
|
+
SessionTimeoutInMinutes = Shapes::IntegerShape.new(name: 'SessionTimeoutInMinutes')
|
199
205
|
SizeInBytes = Shapes::FloatShape.new(name: 'SizeInBytes')
|
200
206
|
SqlQuery = Shapes::StringShape.new(name: 'SqlQuery')
|
201
207
|
SqlQueryDatasetAction = Shapes::StructureShape.new(name: 'SqlQueryDatasetAction')
|
@@ -268,6 +274,7 @@ module Aws::IoTAnalytics
|
|
268
274
|
Channel.add_member(:retention_period, Shapes::ShapeRef.new(shape: RetentionPeriod, location_name: "retentionPeriod"))
|
269
275
|
Channel.add_member(:creation_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "creationTime"))
|
270
276
|
Channel.add_member(:last_update_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "lastUpdateTime"))
|
277
|
+
Channel.add_member(:last_message_arrival_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "lastMessageArrivalTime"))
|
271
278
|
Channel.struct_class = Types::Channel
|
272
279
|
|
273
280
|
ChannelActivity.add_member(:name, Shapes::ShapeRef.new(shape: ActivityName, required: true, location_name: "name"))
|
@@ -293,6 +300,7 @@ module Aws::IoTAnalytics
|
|
293
300
|
ChannelSummary.add_member(:status, Shapes::ShapeRef.new(shape: ChannelStatus, location_name: "status"))
|
294
301
|
ChannelSummary.add_member(:creation_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "creationTime"))
|
295
302
|
ChannelSummary.add_member(:last_update_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "lastUpdateTime"))
|
303
|
+
ChannelSummary.add_member(:last_message_arrival_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "lastMessageArrivalTime"))
|
296
304
|
ChannelSummary.struct_class = Types::ChannelSummary
|
297
305
|
|
298
306
|
ContainerDatasetAction.add_member(:image, Shapes::ShapeRef.new(shape: Image, required: true, location_name: "image"))
|
@@ -313,6 +321,7 @@ module Aws::IoTAnalytics
|
|
313
321
|
CreateChannelResponse.struct_class = Types::CreateChannelResponse
|
314
322
|
|
315
323
|
CreateDatasetContentRequest.add_member(:dataset_name, Shapes::ShapeRef.new(shape: DatasetName, required: true, location: "uri", location_name: "datasetName"))
|
324
|
+
CreateDatasetContentRequest.add_member(:version_id, Shapes::ShapeRef.new(shape: DatasetContentVersion, location_name: "versionId"))
|
316
325
|
CreateDatasetContentRequest.struct_class = Types::CreateDatasetContentRequest
|
317
326
|
|
318
327
|
CreateDatasetContentResponse.add_member(:version_id, Shapes::ShapeRef.new(shape: DatasetContentVersion, location_name: "versionId"))
|
@@ -325,6 +334,7 @@ module Aws::IoTAnalytics
|
|
325
334
|
CreateDatasetRequest.add_member(:retention_period, Shapes::ShapeRef.new(shape: RetentionPeriod, location_name: "retentionPeriod"))
|
326
335
|
CreateDatasetRequest.add_member(:versioning_configuration, Shapes::ShapeRef.new(shape: VersioningConfiguration, location_name: "versioningConfiguration"))
|
327
336
|
CreateDatasetRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "tags"))
|
337
|
+
CreateDatasetRequest.add_member(:late_data_rules, Shapes::ShapeRef.new(shape: LateDataRules, location_name: "lateDataRules"))
|
328
338
|
CreateDatasetRequest.struct_class = Types::CreateDatasetRequest
|
329
339
|
|
330
340
|
CreateDatasetResponse.add_member(:dataset_name, Shapes::ShapeRef.new(shape: DatasetName, location_name: "datasetName"))
|
@@ -382,6 +392,7 @@ module Aws::IoTAnalytics
|
|
382
392
|
Dataset.add_member(:last_update_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "lastUpdateTime"))
|
383
393
|
Dataset.add_member(:retention_period, Shapes::ShapeRef.new(shape: RetentionPeriod, location_name: "retentionPeriod"))
|
384
394
|
Dataset.add_member(:versioning_configuration, Shapes::ShapeRef.new(shape: VersioningConfiguration, location_name: "versioningConfiguration"))
|
395
|
+
Dataset.add_member(:late_data_rules, Shapes::ShapeRef.new(shape: LateDataRules, location_name: "lateDataRules"))
|
385
396
|
Dataset.struct_class = Types::Dataset
|
386
397
|
|
387
398
|
DatasetAction.add_member(:action_name, Shapes::ShapeRef.new(shape: DatasetActionName, location_name: "actionName"))
|
@@ -452,6 +463,7 @@ module Aws::IoTAnalytics
|
|
452
463
|
Datastore.add_member(:retention_period, Shapes::ShapeRef.new(shape: RetentionPeriod, location_name: "retentionPeriod"))
|
453
464
|
Datastore.add_member(:creation_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "creationTime"))
|
454
465
|
Datastore.add_member(:last_update_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "lastUpdateTime"))
|
466
|
+
Datastore.add_member(:last_message_arrival_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "lastMessageArrivalTime"))
|
455
467
|
Datastore.struct_class = Types::Datastore
|
456
468
|
|
457
469
|
DatastoreActivity.add_member(:name, Shapes::ShapeRef.new(shape: ActivityName, required: true, location_name: "name"))
|
@@ -476,6 +488,7 @@ module Aws::IoTAnalytics
|
|
476
488
|
DatastoreSummary.add_member(:status, Shapes::ShapeRef.new(shape: DatastoreStatus, location_name: "status"))
|
477
489
|
DatastoreSummary.add_member(:creation_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "creationTime"))
|
478
490
|
DatastoreSummary.add_member(:last_update_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "lastUpdateTime"))
|
491
|
+
DatastoreSummary.add_member(:last_message_arrival_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "lastMessageArrivalTime"))
|
479
492
|
DatastoreSummary.struct_class = Types::DatastoreSummary
|
480
493
|
|
481
494
|
DeleteChannelRequest.add_member(:channel_name, Shapes::ShapeRef.new(shape: ChannelName, required: true, location: "uri", location_name: "channelName"))
|
@@ -498,6 +511,9 @@ module Aws::IoTAnalytics
|
|
498
511
|
DeltaTime.add_member(:time_expression, Shapes::ShapeRef.new(shape: TimeExpression, required: true, location_name: "timeExpression"))
|
499
512
|
DeltaTime.struct_class = Types::DeltaTime
|
500
513
|
|
514
|
+
DeltaTimeSessionWindowConfiguration.add_member(:timeout_in_minutes, Shapes::ShapeRef.new(shape: SessionTimeoutInMinutes, required: true, location_name: "timeoutInMinutes"))
|
515
|
+
DeltaTimeSessionWindowConfiguration.struct_class = Types::DeltaTimeSessionWindowConfiguration
|
516
|
+
|
501
517
|
DescribeChannelRequest.add_member(:channel_name, Shapes::ShapeRef.new(shape: ChannelName, required: true, location: "uri", location_name: "channelName"))
|
502
518
|
DescribeChannelRequest.add_member(:include_statistics, Shapes::ShapeRef.new(shape: IncludeStatisticsFlag, location: "querystring", location_name: "includeStatistics"))
|
503
519
|
DescribeChannelRequest.struct_class = Types::DescribeChannelRequest
|
@@ -583,6 +599,15 @@ module Aws::IoTAnalytics
|
|
583
599
|
LambdaActivity.add_member(:next, Shapes::ShapeRef.new(shape: ActivityName, location_name: "next"))
|
584
600
|
LambdaActivity.struct_class = Types::LambdaActivity
|
585
601
|
|
602
|
+
LateDataRule.add_member(:rule_name, Shapes::ShapeRef.new(shape: LateDataRuleName, location_name: "ruleName"))
|
603
|
+
LateDataRule.add_member(:rule_configuration, Shapes::ShapeRef.new(shape: LateDataRuleConfiguration, required: true, location_name: "ruleConfiguration"))
|
604
|
+
LateDataRule.struct_class = Types::LateDataRule
|
605
|
+
|
606
|
+
LateDataRuleConfiguration.add_member(:delta_time_session_window_configuration, Shapes::ShapeRef.new(shape: DeltaTimeSessionWindowConfiguration, location_name: "deltaTimeSessionWindowConfiguration"))
|
607
|
+
LateDataRuleConfiguration.struct_class = Types::LateDataRuleConfiguration
|
608
|
+
|
609
|
+
LateDataRules.member = Shapes::ShapeRef.new(shape: LateDataRule)
|
610
|
+
|
586
611
|
LimitExceededException.add_member(:message, Shapes::ShapeRef.new(shape: errorMessage, location_name: "message"))
|
587
612
|
LimitExceededException.struct_class = Types::LimitExceededException
|
588
613
|
|
@@ -814,6 +839,7 @@ module Aws::IoTAnalytics
|
|
814
839
|
UpdateDatasetRequest.add_member(:content_delivery_rules, Shapes::ShapeRef.new(shape: DatasetContentDeliveryRules, location_name: "contentDeliveryRules"))
|
815
840
|
UpdateDatasetRequest.add_member(:retention_period, Shapes::ShapeRef.new(shape: RetentionPeriod, location_name: "retentionPeriod"))
|
816
841
|
UpdateDatasetRequest.add_member(:versioning_configuration, Shapes::ShapeRef.new(shape: VersioningConfiguration, location_name: "versioningConfiguration"))
|
842
|
+
UpdateDatasetRequest.add_member(:late_data_rules, Shapes::ShapeRef.new(shape: LateDataRules, location_name: "lateDataRules"))
|
817
843
|
UpdateDatasetRequest.struct_class = Types::UpdateDatasetRequest
|
818
844
|
|
819
845
|
UpdateDatastoreRequest.add_member(:datastore_name, Shapes::ShapeRef.new(shape: DatastoreName, required: true, location: "uri", location_name: "datastoreName"))
|
@@ -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
|
@@ -251,10 +263,10 @@ module Aws::IoTAnalytics
|
|
251
263
|
include Aws::Structure
|
252
264
|
end
|
253
265
|
|
254
|
-
# Where channel data is stored. You may choose one of
|
255
|
-
#
|
256
|
-
#
|
257
|
-
#
|
266
|
+
# Where channel data is stored. You may choose one of `serviceManagedS3`
|
267
|
+
# or `customerManagedS3` storage. If not specified, the default is
|
268
|
+
# `serviceManagedS3`. This cannot be changed after creation of the
|
269
|
+
# channel.
|
258
270
|
#
|
259
271
|
# @note When making an API call, you may pass ChannelStorage
|
260
272
|
# data as a hash:
|
@@ -270,18 +282,17 @@ module Aws::IoTAnalytics
|
|
270
282
|
# }
|
271
283
|
#
|
272
284
|
# @!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.
|
285
|
+
# Use this to store channel data in an S3 bucket managed by AWS IoT
|
286
|
+
# Analytics. You cannot change the choice of service-managed or
|
287
|
+
# customer-managed S3 storage after the channel is created.
|
277
288
|
# @return [Types::ServiceManagedChannelS3Storage]
|
278
289
|
#
|
279
290
|
# @!attribute [rw] customer_managed_s3
|
280
291
|
# 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
|
-
#
|
292
|
+
# customer managed storage is selected, the `retentionPeriod`
|
293
|
+
# parameter is ignored. You cannot change the choice of
|
294
|
+
# service-managed or customer-managed S3 storage after the channel is
|
295
|
+
# created.
|
285
296
|
# @return [Types::CustomerManagedChannelS3Storage]
|
286
297
|
#
|
287
298
|
class ChannelStorage < Struct.new(
|
@@ -294,8 +305,8 @@ module Aws::IoTAnalytics
|
|
294
305
|
# Where channel data is stored.
|
295
306
|
#
|
296
307
|
# @!attribute [rw] service_managed_s3
|
297
|
-
# Used to store channel data in an S3 bucket managed by
|
298
|
-
# Analytics
|
308
|
+
# Used to store channel data in an S3 bucket managed by AWS IoT
|
309
|
+
# Analytics.
|
299
310
|
# @return [Types::ServiceManagedChannelS3StorageSummary]
|
300
311
|
#
|
301
312
|
# @!attribute [rw] customer_managed_s3
|
@@ -331,17 +342,29 @@ module Aws::IoTAnalytics
|
|
331
342
|
# The last time the channel was updated.
|
332
343
|
# @return [Time]
|
333
344
|
#
|
345
|
+
# @!attribute [rw] last_message_arrival_time
|
346
|
+
# The last time when a new message arrived in the channel.
|
347
|
+
#
|
348
|
+
# AWS IoT Analytics updates this value at most once per minute for one
|
349
|
+
# channel. Hence, the `lastMessageArrivalTime` value is an
|
350
|
+
# approximation.
|
351
|
+
#
|
352
|
+
# This feature only applies to messages that arrived in the data store
|
353
|
+
# after October 23, 2020.
|
354
|
+
# @return [Time]
|
355
|
+
#
|
334
356
|
class ChannelSummary < Struct.new(
|
335
357
|
:channel_name,
|
336
358
|
:channel_storage,
|
337
359
|
:status,
|
338
360
|
:creation_time,
|
339
|
-
:last_update_time
|
361
|
+
:last_update_time,
|
362
|
+
:last_message_arrival_time)
|
340
363
|
SENSITIVE = []
|
341
364
|
include Aws::Structure
|
342
365
|
end
|
343
366
|
|
344
|
-
# Information
|
367
|
+
# Information required to run the `containerAction` to produce dataset
|
345
368
|
# contents.
|
346
369
|
#
|
347
370
|
# @note When making an API call, you may pass ContainerDatasetAction
|
@@ -371,28 +394,27 @@ module Aws::IoTAnalytics
|
|
371
394
|
#
|
372
395
|
# @!attribute [rw] image
|
373
396
|
# The ARN of the Docker container stored in your account. The Docker
|
374
|
-
# container contains an application and
|
375
|
-
# is used to generate
|
397
|
+
# container contains an application and required support libraries and
|
398
|
+
# is used to generate dataset contents.
|
376
399
|
# @return [String]
|
377
400
|
#
|
378
401
|
# @!attribute [rw] execution_role_arn
|
379
|
-
# The ARN of the role
|
380
|
-
#
|
381
|
-
#
|
382
|
-
#
|
402
|
+
# The ARN of the role that gives permission to the system to access
|
403
|
+
# required resources to run the `containerAction`. This includes, at
|
404
|
+
# minimum, permission to retrieve the dataset contents that are the
|
405
|
+
# input to the containerized application.
|
383
406
|
# @return [String]
|
384
407
|
#
|
385
408
|
# @!attribute [rw] resource_configuration
|
386
|
-
# Configuration of the resource
|
387
|
-
# "containerAction".
|
409
|
+
# Configuration of the resource that executes the `containerAction`.
|
388
410
|
# @return [Types::ResourceConfiguration]
|
389
411
|
#
|
390
412
|
# @!attribute [rw] variables
|
391
|
-
# The values of variables used
|
392
|
-
#
|
413
|
+
# The values of variables used in the context of the execution of the
|
414
|
+
# containerized application (basically, parameters passed to the
|
393
415
|
# application). Each variable must have a name and a value given by
|
394
|
-
# one of
|
395
|
-
#
|
416
|
+
# one of `stringValue`, `datasetContentVersionValue`, or
|
417
|
+
# `outputFileUriValue`.
|
396
418
|
# @return [Array<Types::Variable>]
|
397
419
|
#
|
398
420
|
class ContainerDatasetAction < Struct.new(
|
@@ -435,16 +457,15 @@ module Aws::IoTAnalytics
|
|
435
457
|
# @return [String]
|
436
458
|
#
|
437
459
|
# @!attribute [rw] channel_storage
|
438
|
-
# Where channel data is stored. You
|
439
|
-
#
|
440
|
-
#
|
441
|
-
#
|
460
|
+
# Where channel data is stored. You can choose one of
|
461
|
+
# `serviceManagedS3` or `customerManagedS3` storage. If not specified,
|
462
|
+
# the default is `serviceManagedS3`. You cannot change this storage
|
463
|
+
# option after the channel is created.
|
442
464
|
# @return [Types::ChannelStorage]
|
443
465
|
#
|
444
466
|
# @!attribute [rw] retention_period
|
445
467
|
# How long, in days, message data is kept for the channel. When
|
446
|
-
#
|
447
|
-
# ignored.
|
468
|
+
# `customerManagedS3` storage is selected, this parameter is ignored.
|
448
469
|
# @return [Types::RetentionPeriod]
|
449
470
|
#
|
450
471
|
# @!attribute [rw] tags
|
@@ -485,20 +506,31 @@ module Aws::IoTAnalytics
|
|
485
506
|
#
|
486
507
|
# {
|
487
508
|
# dataset_name: "DatasetName", # required
|
509
|
+
# version_id: "DatasetContentVersion",
|
488
510
|
# }
|
489
511
|
#
|
490
512
|
# @!attribute [rw] dataset_name
|
491
|
-
# The name of the
|
513
|
+
# The name of the dataset.
|
514
|
+
# @return [String]
|
515
|
+
#
|
516
|
+
# @!attribute [rw] version_id
|
517
|
+
# The version ID of the dataset content. To specify `versionId` for a
|
518
|
+
# dataset content, the dataset must use a [DeltaTimer][1] filter.
|
519
|
+
#
|
520
|
+
#
|
521
|
+
#
|
522
|
+
# [1]: https://docs.aws.amazon.com/iotanalytics/latest/APIReference/API_DeltaTime.html
|
492
523
|
# @return [String]
|
493
524
|
#
|
494
525
|
class CreateDatasetContentRequest < Struct.new(
|
495
|
-
:dataset_name
|
526
|
+
:dataset_name,
|
527
|
+
:version_id)
|
496
528
|
SENSITIVE = []
|
497
529
|
include Aws::Structure
|
498
530
|
end
|
499
531
|
|
500
532
|
# @!attribute [rw] version_id
|
501
|
-
# The version ID of the
|
533
|
+
# The version ID of the dataset contents that are being created.
|
502
534
|
# @return [String]
|
503
535
|
#
|
504
536
|
class CreateDatasetContentResponse < Struct.new(
|
@@ -593,6 +625,16 @@ module Aws::IoTAnalytics
|
|
593
625
|
# value: "TagValue", # required
|
594
626
|
# },
|
595
627
|
# ],
|
628
|
+
# late_data_rules: [
|
629
|
+
# {
|
630
|
+
# rule_name: "LateDataRuleName",
|
631
|
+
# rule_configuration: { # required
|
632
|
+
# delta_time_session_window_configuration: {
|
633
|
+
# timeout_in_minutes: 1, # required
|
634
|
+
# },
|
635
|
+
# },
|
636
|
+
# },
|
637
|
+
# ],
|
596
638
|
# }
|
597
639
|
#
|
598
640
|
# @!attribute [rw] dataset_name
|
@@ -607,36 +649,55 @@ module Aws::IoTAnalytics
|
|
607
649
|
# A list of triggers. A trigger causes data set contents to be
|
608
650
|
# populated at a specified time interval or when another data set's
|
609
651
|
# contents are created. The list of triggers can be empty or contain
|
610
|
-
# up to five
|
652
|
+
# up to five `DataSetTrigger` objects.
|
611
653
|
# @return [Array<Types::DatasetTrigger>]
|
612
654
|
#
|
613
655
|
# @!attribute [rw] content_delivery_rules
|
614
|
-
# When
|
656
|
+
# When dataset contents are created, they are delivered to
|
615
657
|
# destinations specified here.
|
616
658
|
# @return [Array<Types::DatasetContentDeliveryRule>]
|
617
659
|
#
|
618
660
|
# @!attribute [rw] retention_period
|
619
|
-
#
|
620
|
-
#
|
621
|
-
#
|
622
|
-
# versions of
|
623
|
-
# `versioningConfiguration` parameter.
|
624
|
-
#
|
661
|
+
# Optional. How long, in days, versions of dataset contents are kept
|
662
|
+
# for the dataset. If not specified or set to `null`, versions of
|
663
|
+
# dataset contents are retained for at most 90 days. The number of
|
664
|
+
# versions of dataset contents retained is determined by the
|
665
|
+
# `versioningConfiguration` parameter. For more information, see
|
666
|
+
# [Keeping Multiple Versions of AWS IoT Analytics Data Sets][1] in the
|
667
|
+
# *AWS IoT Analytics User Guide*.
|
668
|
+
#
|
669
|
+
#
|
670
|
+
#
|
671
|
+
# [1]: https://docs.aws.amazon.com/iotanalytics/latest/userguide/getting-started.html#aws-iot-analytics-dataset-versions
|
625
672
|
# @return [Types::RetentionPeriod]
|
626
673
|
#
|
627
674
|
# @!attribute [rw] versioning_configuration
|
628
|
-
#
|
675
|
+
# Optional. How many versions of dataset contents are kept. If not
|
629
676
|
# specified or set to null, only the latest version plus the latest
|
630
677
|
# succeeded version (if they are different) are kept for the time
|
631
|
-
# period specified by the
|
632
|
-
# information, see
|
633
|
-
#
|
678
|
+
# period specified by the `retentionPeriod` parameter. For more
|
679
|
+
# information, see [Keeping Multiple Versions of AWS IoT Analytics
|
680
|
+
# Data Sets][1] in the *AWS IoT Analytics User Guide*.
|
681
|
+
#
|
682
|
+
#
|
683
|
+
#
|
684
|
+
# [1]: https://docs.aws.amazon.com/iotanalytics/latest/userguide/getting-started.html#aws-iot-analytics-dataset-versions
|
634
685
|
# @return [Types::VersioningConfiguration]
|
635
686
|
#
|
636
687
|
# @!attribute [rw] tags
|
637
688
|
# Metadata which can be used to manage the data set.
|
638
689
|
# @return [Array<Types::Tag>]
|
639
690
|
#
|
691
|
+
# @!attribute [rw] late_data_rules
|
692
|
+
# A list of data rules that send notifications to Amazon CloudWatch,
|
693
|
+
# when data arrives late. To specify `lateDataRules`, the dataset must
|
694
|
+
# use a [DeltaTimer][1] filter.
|
695
|
+
#
|
696
|
+
#
|
697
|
+
#
|
698
|
+
# [1]: https://docs.aws.amazon.com/iotanalytics/latest/APIReference/API_DeltaTime.html
|
699
|
+
# @return [Array<Types::LateDataRule>]
|
700
|
+
#
|
640
701
|
class CreateDatasetRequest < Struct.new(
|
641
702
|
:dataset_name,
|
642
703
|
:actions,
|
@@ -644,21 +705,22 @@ module Aws::IoTAnalytics
|
|
644
705
|
:content_delivery_rules,
|
645
706
|
:retention_period,
|
646
707
|
:versioning_configuration,
|
647
|
-
:tags
|
708
|
+
:tags,
|
709
|
+
:late_data_rules)
|
648
710
|
SENSITIVE = []
|
649
711
|
include Aws::Structure
|
650
712
|
end
|
651
713
|
|
652
714
|
# @!attribute [rw] dataset_name
|
653
|
-
# The name of the
|
715
|
+
# The name of the dataset.
|
654
716
|
# @return [String]
|
655
717
|
#
|
656
718
|
# @!attribute [rw] dataset_arn
|
657
|
-
# The ARN of the
|
719
|
+
# The ARN of the dataset.
|
658
720
|
# @return [String]
|
659
721
|
#
|
660
722
|
# @!attribute [rw] retention_period
|
661
|
-
# How long, in days,
|
723
|
+
# How long, in days, dataset contents are kept for the dataset.
|
662
724
|
# @return [Types::RetentionPeriod]
|
663
725
|
#
|
664
726
|
class CreateDatasetResponse < Struct.new(
|
@@ -700,16 +762,15 @@ module Aws::IoTAnalytics
|
|
700
762
|
# @return [String]
|
701
763
|
#
|
702
764
|
# @!attribute [rw] datastore_storage
|
703
|
-
# Where data store data is stored. You
|
704
|
-
#
|
705
|
-
#
|
706
|
-
#
|
765
|
+
# Where data store data is stored. You can choose one of
|
766
|
+
# `serviceManagedS3` or `customerManagedS3` storage. If not specified,
|
767
|
+
# the default is `serviceManagedS3`. You cannot change this storage
|
768
|
+
# option after the data store is created.
|
707
769
|
# @return [Types::DatastoreStorage]
|
708
770
|
#
|
709
771
|
# @!attribute [rw] retention_period
|
710
772
|
# How long, in days, message data is kept for the data store. When
|
711
|
-
#
|
712
|
-
# ignored.
|
773
|
+
# `customerManagedS3` storage is selected, this parameter is ignored.
|
713
774
|
# @return [Types::RetentionPeriod]
|
714
775
|
#
|
715
776
|
# @!attribute [rw] tags
|
@@ -824,16 +885,16 @@ module Aws::IoTAnalytics
|
|
824
885
|
# @return [String]
|
825
886
|
#
|
826
887
|
# @!attribute [rw] pipeline_activities
|
827
|
-
# A list of
|
888
|
+
# A list of `PipelineActivity` objects. Activities perform
|
828
889
|
# transformations on your messages, such as removing, renaming or
|
829
890
|
# adding message attributes; filtering messages based on attribute
|
830
891
|
# values; invoking your Lambda functions on messages for advanced
|
831
892
|
# processing; or performing mathematical transformations to normalize
|
832
893
|
# device data.
|
833
894
|
#
|
834
|
-
# The list can be 2-25
|
895
|
+
# The list can be 2-25 `PipelineActivity` objects and must contain
|
835
896
|
# both a `channel` and a `datastore` activity. Each entry in the list
|
836
|
-
# must contain only one activity
|
897
|
+
# must contain only one activity. For example:
|
837
898
|
#
|
838
899
|
# `pipelineActivities = [ \{ "channel": \{ ... \} \}, \{ "lambda": \{
|
839
900
|
# ... \} \}, ... ]`
|
@@ -867,10 +928,9 @@ module Aws::IoTAnalytics
|
|
867
928
|
end
|
868
929
|
|
869
930
|
# 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.
|
931
|
+
# customer managed storage is selected, the `retentionPeriod` parameter
|
932
|
+
# is ignored. You cannot change the choice of service-managed or
|
933
|
+
# customer-managed S3 storage after the channel is created.
|
874
934
|
#
|
875
935
|
# @note When making an API call, you may pass CustomerManagedChannelS3Storage
|
876
936
|
# data as a hash:
|
@@ -882,18 +942,18 @@ module Aws::IoTAnalytics
|
|
882
942
|
# }
|
883
943
|
#
|
884
944
|
# @!attribute [rw] bucket
|
885
|
-
# The name of the
|
945
|
+
# The name of the S3 bucket in which channel data is stored.
|
886
946
|
# @return [String]
|
887
947
|
#
|
888
948
|
# @!attribute [rw] key_prefix
|
889
|
-
#
|
890
|
-
# objects. Each object in an
|
891
|
-
#
|
892
|
-
#
|
949
|
+
# Optional. The prefix used to create the keys of the channel data
|
950
|
+
# objects. Each object in an S3 bucket has a key that is its unique
|
951
|
+
# identifier in the bucket. Each object in a bucket has exactly one
|
952
|
+
# key. The prefix must end with a forward slash (/).
|
893
953
|
# @return [String]
|
894
954
|
#
|
895
955
|
# @!attribute [rw] role_arn
|
896
|
-
# The ARN of the role
|
956
|
+
# The ARN of the role that grants AWS IoT Analytics permission to
|
897
957
|
# interact with your Amazon S3 resources.
|
898
958
|
# @return [String]
|
899
959
|
#
|
@@ -908,18 +968,18 @@ module Aws::IoTAnalytics
|
|
908
968
|
# Used to store channel data in an S3 bucket that you manage.
|
909
969
|
#
|
910
970
|
# @!attribute [rw] bucket
|
911
|
-
# The name of the
|
971
|
+
# The name of the S3 bucket in which channel data is stored.
|
912
972
|
# @return [String]
|
913
973
|
#
|
914
974
|
# @!attribute [rw] key_prefix
|
915
|
-
#
|
916
|
-
# objects. Each object in an
|
917
|
-
#
|
918
|
-
#
|
975
|
+
# Optional. The prefix used to create the keys of the channel data
|
976
|
+
# objects. Each object in an S3 bucket has a key that is its unique
|
977
|
+
# identifier within the bucket (each object in a bucket has exactly
|
978
|
+
# one key). The prefix must end with a forward slash (/).
|
919
979
|
# @return [String]
|
920
980
|
#
|
921
981
|
# @!attribute [rw] role_arn
|
922
|
-
# The ARN of the role
|
982
|
+
# The ARN of the role that grants AWS IoT Analytics permission to
|
923
983
|
# interact with your Amazon S3 resources.
|
924
984
|
# @return [String]
|
925
985
|
#
|
@@ -932,10 +992,9 @@ module Aws::IoTAnalytics
|
|
932
992
|
end
|
933
993
|
|
934
994
|
# 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.
|
995
|
+
# When customer-managed storage is selected, the `retentionPeriod`
|
996
|
+
# parameter is ignored. You cannot change the choice of service-managed
|
997
|
+
# or customer-managed S3 storage after the data store is created.
|
939
998
|
#
|
940
999
|
# @note When making an API call, you may pass CustomerManagedDatastoreS3Storage
|
941
1000
|
# data as a hash:
|
@@ -947,18 +1006,18 @@ module Aws::IoTAnalytics
|
|
947
1006
|
# }
|
948
1007
|
#
|
949
1008
|
# @!attribute [rw] bucket
|
950
|
-
# The name of the
|
1009
|
+
# The name of the S3 bucket in which data store data is stored.
|
951
1010
|
# @return [String]
|
952
1011
|
#
|
953
1012
|
# @!attribute [rw] key_prefix
|
954
|
-
#
|
955
|
-
#
|
956
|
-
#
|
957
|
-
#
|
1013
|
+
# Optional. The prefix used to create the keys of the data store data
|
1014
|
+
# objects. Each object in an S3 bucket has a key that is its unique
|
1015
|
+
# identifier in the bucket. Each object in a bucket has exactly one
|
1016
|
+
# key. The prefix must end with a forward slash (/).
|
958
1017
|
# @return [String]
|
959
1018
|
#
|
960
1019
|
# @!attribute [rw] role_arn
|
961
|
-
# The ARN of the role
|
1020
|
+
# The ARN of the role that grants AWS IoT Analytics permission to
|
962
1021
|
# interact with your Amazon S3 resources.
|
963
1022
|
# @return [String]
|
964
1023
|
#
|
@@ -973,18 +1032,18 @@ module Aws::IoTAnalytics
|
|
973
1032
|
# Used to store data store data in an S3 bucket that you manage.
|
974
1033
|
#
|
975
1034
|
# @!attribute [rw] bucket
|
976
|
-
# The name of the
|
1035
|
+
# The name of the S3 bucket in which data store data is stored.
|
977
1036
|
# @return [String]
|
978
1037
|
#
|
979
1038
|
# @!attribute [rw] key_prefix
|
980
|
-
#
|
981
|
-
#
|
982
|
-
#
|
983
|
-
#
|
1039
|
+
# Optional. The prefix used to create the keys of the data store data
|
1040
|
+
# objects. Each object in an S3 bucket has a key that is its unique
|
1041
|
+
# identifier in the bucket. Each object in a bucket has exactly one
|
1042
|
+
# key. The prefix must end with a forward slash (/).
|
984
1043
|
# @return [String]
|
985
1044
|
#
|
986
1045
|
# @!attribute [rw] role_arn
|
987
|
-
# The ARN of the role
|
1046
|
+
# The ARN of the role that grants AWS IoT Analytics permission to
|
988
1047
|
# interact with your Amazon S3 resources.
|
989
1048
|
# @return [String]
|
990
1049
|
#
|
@@ -1007,18 +1066,18 @@ module Aws::IoTAnalytics
|
|
1007
1066
|
# @return [String]
|
1008
1067
|
#
|
1009
1068
|
# @!attribute [rw] actions
|
1010
|
-
# The
|
1069
|
+
# The `DatasetAction` objects that automatically create the data set
|
1011
1070
|
# contents.
|
1012
1071
|
# @return [Array<Types::DatasetAction>]
|
1013
1072
|
#
|
1014
1073
|
# @!attribute [rw] triggers
|
1015
|
-
# The
|
1074
|
+
# The `DatasetTrigger` objects that specify when the data set is
|
1016
1075
|
# automatically updated.
|
1017
1076
|
# @return [Array<Types::DatasetTrigger>]
|
1018
1077
|
#
|
1019
1078
|
# @!attribute [rw] content_delivery_rules
|
1020
|
-
# When
|
1021
|
-
#
|
1079
|
+
# When dataset contents are created they are delivered to destinations
|
1080
|
+
# specified here.
|
1022
1081
|
# @return [Array<Types::DatasetContentDeliveryRule>]
|
1023
1082
|
#
|
1024
1083
|
# @!attribute [rw] status
|
@@ -1034,19 +1093,32 @@ module Aws::IoTAnalytics
|
|
1034
1093
|
# @return [Time]
|
1035
1094
|
#
|
1036
1095
|
# @!attribute [rw] retention_period
|
1037
|
-
#
|
1038
|
-
# set.
|
1096
|
+
# Optional. How long, in days, message data is kept for the data set.
|
1039
1097
|
# @return [Types::RetentionPeriod]
|
1040
1098
|
#
|
1041
1099
|
# @!attribute [rw] versioning_configuration
|
1042
|
-
#
|
1100
|
+
# Optional. How many versions of dataset contents are kept. If not
|
1043
1101
|
# specified or set to null, only the latest version plus the latest
|
1044
1102
|
# succeeded version (if they are different) are kept for the time
|
1045
|
-
# period specified by the
|
1046
|
-
# information, see
|
1047
|
-
#
|
1103
|
+
# period specified by the `retentionPeriod` parameter. For more
|
1104
|
+
# information, see [Keeping Multiple Versions of AWS IoT Analytics
|
1105
|
+
# Data Sets][1] in the *AWS IoT Analytics User Guide*.
|
1106
|
+
#
|
1107
|
+
#
|
1108
|
+
#
|
1109
|
+
# [1]: https://docs.aws.amazon.com/iotanalytics/latest/userguide/getting-started.html#aws-iot-analytics-dataset-versions
|
1048
1110
|
# @return [Types::VersioningConfiguration]
|
1049
1111
|
#
|
1112
|
+
# @!attribute [rw] late_data_rules
|
1113
|
+
# A list of data rules that send notifications to Amazon CloudWatch,
|
1114
|
+
# when data arrives late. To specify `lateDataRules`, the dataset must
|
1115
|
+
# use a [DeltaTimer][1] filter.
|
1116
|
+
#
|
1117
|
+
#
|
1118
|
+
#
|
1119
|
+
# [1]: https://docs.aws.amazon.com/iotanalytics/latest/APIReference/API_DeltaTime.html
|
1120
|
+
# @return [Array<Types::LateDataRule>]
|
1121
|
+
#
|
1050
1122
|
class Dataset < Struct.new(
|
1051
1123
|
:name,
|
1052
1124
|
:arn,
|
@@ -1057,12 +1129,13 @@ module Aws::IoTAnalytics
|
|
1057
1129
|
:creation_time,
|
1058
1130
|
:last_update_time,
|
1059
1131
|
:retention_period,
|
1060
|
-
:versioning_configuration
|
1132
|
+
:versioning_configuration,
|
1133
|
+
:late_data_rules)
|
1061
1134
|
SENSITIVE = []
|
1062
1135
|
include Aws::Structure
|
1063
1136
|
end
|
1064
1137
|
|
1065
|
-
# A
|
1138
|
+
# A `DatasetAction` object that specifies how data set contents are
|
1066
1139
|
# automatically created.
|
1067
1140
|
#
|
1068
1141
|
# @note When making an API call, you may pass DatasetAction
|
@@ -1110,15 +1183,14 @@ module Aws::IoTAnalytics
|
|
1110
1183
|
# @return [String]
|
1111
1184
|
#
|
1112
1185
|
# @!attribute [rw] query_action
|
1113
|
-
# An
|
1186
|
+
# An `SqlQueryDatasetAction` object that uses an SQL query to
|
1114
1187
|
# automatically create data set contents.
|
1115
1188
|
# @return [Types::SqlQueryDatasetAction]
|
1116
1189
|
#
|
1117
1190
|
# @!attribute [rw] container_action
|
1118
|
-
# Information
|
1119
|
-
# application
|
1120
|
-
#
|
1121
|
-
# support libraries.
|
1191
|
+
# Information that allows the system to run a containerized
|
1192
|
+
# application to create the dataset contents. The application must be
|
1193
|
+
# in a Docker container along with any required support libraries.
|
1122
1194
|
# @return [Types::ContainerDatasetAction]
|
1123
1195
|
#
|
1124
1196
|
class DatasetAction < Struct.new(
|
@@ -1129,16 +1201,16 @@ module Aws::IoTAnalytics
|
|
1129
1201
|
include Aws::Structure
|
1130
1202
|
end
|
1131
1203
|
|
1132
|
-
# Information about the action
|
1133
|
-
#
|
1204
|
+
# Information about the action that automatically creates the dataset's
|
1205
|
+
# contents.
|
1134
1206
|
#
|
1135
1207
|
# @!attribute [rw] action_name
|
1136
|
-
# The name of the action
|
1208
|
+
# The name of the action that automatically creates the dataset's
|
1137
1209
|
# contents.
|
1138
1210
|
# @return [String]
|
1139
1211
|
#
|
1140
1212
|
# @!attribute [rw] action_type
|
1141
|
-
# The type of action by which the
|
1213
|
+
# The type of action by which the dataset's contents are
|
1142
1214
|
# automatically created.
|
1143
1215
|
# @return [String]
|
1144
1216
|
#
|
@@ -1149,7 +1221,7 @@ module Aws::IoTAnalytics
|
|
1149
1221
|
include Aws::Structure
|
1150
1222
|
end
|
1151
1223
|
|
1152
|
-
# The destination to which
|
1224
|
+
# The destination to which dataset contents are delivered.
|
1153
1225
|
#
|
1154
1226
|
# @note When making an API call, you may pass DatasetContentDeliveryDestination
|
1155
1227
|
# data as a hash:
|
@@ -1171,13 +1243,13 @@ module Aws::IoTAnalytics
|
|
1171
1243
|
# }
|
1172
1244
|
#
|
1173
1245
|
# @!attribute [rw] iot_events_destination_configuration
|
1174
|
-
# Configuration information for delivery of
|
1246
|
+
# Configuration information for delivery of dataset contents to AWS
|
1175
1247
|
# IoT Events.
|
1176
1248
|
# @return [Types::IotEventsDestinationConfiguration]
|
1177
1249
|
#
|
1178
1250
|
# @!attribute [rw] s3_destination_configuration
|
1179
|
-
# Configuration information for delivery of
|
1180
|
-
#
|
1251
|
+
# Configuration information for delivery of dataset contents to Amazon
|
1252
|
+
# S3.
|
1181
1253
|
# @return [Types::S3DestinationConfiguration]
|
1182
1254
|
#
|
1183
1255
|
class DatasetContentDeliveryDestination < Struct.new(
|
@@ -1187,7 +1259,7 @@ module Aws::IoTAnalytics
|
|
1187
1259
|
include Aws::Structure
|
1188
1260
|
end
|
1189
1261
|
|
1190
|
-
# When
|
1262
|
+
# When dataset contents are created, they are delivered to destination
|
1191
1263
|
# specified here.
|
1192
1264
|
#
|
1193
1265
|
# @note When making an API call, you may pass DatasetContentDeliveryRule
|
@@ -1213,11 +1285,11 @@ module Aws::IoTAnalytics
|
|
1213
1285
|
# }
|
1214
1286
|
#
|
1215
1287
|
# @!attribute [rw] entry_name
|
1216
|
-
# The name of the
|
1288
|
+
# The name of the dataset content delivery rules entry.
|
1217
1289
|
# @return [String]
|
1218
1290
|
#
|
1219
1291
|
# @!attribute [rw] destination
|
1220
|
-
# The destination to which
|
1292
|
+
# The destination to which dataset contents are delivered.
|
1221
1293
|
# @return [Types::DatasetContentDeliveryDestination]
|
1222
1294
|
#
|
1223
1295
|
class DatasetContentDeliveryRule < Struct.new(
|
@@ -1231,8 +1303,8 @@ module Aws::IoTAnalytics
|
|
1231
1303
|
# state.
|
1232
1304
|
#
|
1233
1305
|
# @!attribute [rw] state
|
1234
|
-
# The state of the data set contents. Can be one of
|
1235
|
-
#
|
1306
|
+
# The state of the data set contents. Can be one of READY, CREATING,
|
1307
|
+
# SUCCEEDED, or FAILED.
|
1236
1308
|
# @return [String]
|
1237
1309
|
#
|
1238
1310
|
# @!attribute [rw] reason
|
@@ -1246,10 +1318,10 @@ module Aws::IoTAnalytics
|
|
1246
1318
|
include Aws::Structure
|
1247
1319
|
end
|
1248
1320
|
|
1249
|
-
# Summary information about
|
1321
|
+
# Summary information about dataset contents.
|
1250
1322
|
#
|
1251
1323
|
# @!attribute [rw] version
|
1252
|
-
# The version of the
|
1324
|
+
# The version of the dataset contents.
|
1253
1325
|
# @return [String]
|
1254
1326
|
#
|
1255
1327
|
# @!attribute [rw] status
|
@@ -1257,11 +1329,11 @@ module Aws::IoTAnalytics
|
|
1257
1329
|
# @return [Types::DatasetContentStatus]
|
1258
1330
|
#
|
1259
1331
|
# @!attribute [rw] creation_time
|
1260
|
-
# The actual time the creation of the
|
1332
|
+
# The actual time the creation of the dataset contents was started.
|
1261
1333
|
# @return [Time]
|
1262
1334
|
#
|
1263
1335
|
# @!attribute [rw] schedule_time
|
1264
|
-
# The time the creation of the
|
1336
|
+
# The time the creation of the dataset contents was scheduled to
|
1265
1337
|
# start.
|
1266
1338
|
# @return [Time]
|
1267
1339
|
#
|
@@ -1280,8 +1352,8 @@ module Aws::IoTAnalytics
|
|
1280
1352
|
include Aws::Structure
|
1281
1353
|
end
|
1282
1354
|
|
1283
|
-
# The
|
1284
|
-
#
|
1355
|
+
# The dataset whose latest contents are used as input to the notebook or
|
1356
|
+
# application.
|
1285
1357
|
#
|
1286
1358
|
# @note When making an API call, you may pass DatasetContentVersionValue
|
1287
1359
|
# data as a hash:
|
@@ -1291,7 +1363,7 @@ module Aws::IoTAnalytics
|
|
1291
1363
|
# }
|
1292
1364
|
#
|
1293
1365
|
# @!attribute [rw] dataset_name
|
1294
|
-
# The name of the
|
1366
|
+
# The name of the dataset whose latest contents are used as input to
|
1295
1367
|
# the notebook or application.
|
1296
1368
|
# @return [String]
|
1297
1369
|
#
|
@@ -1308,7 +1380,7 @@ module Aws::IoTAnalytics
|
|
1308
1380
|
# @return [String]
|
1309
1381
|
#
|
1310
1382
|
# @!attribute [rw] data_uri
|
1311
|
-
# The
|
1383
|
+
# The presigned URI of the data set item.
|
1312
1384
|
# @return [String]
|
1313
1385
|
#
|
1314
1386
|
class DatasetEntry < Struct.new(
|
@@ -1340,11 +1412,11 @@ module Aws::IoTAnalytics
|
|
1340
1412
|
# A list of triggers. A trigger causes data set content to be
|
1341
1413
|
# populated at a specified time interval or when another data set is
|
1342
1414
|
# populated. The list of triggers can be empty or contain up to five
|
1343
|
-
# DataSetTrigger objects
|
1415
|
+
# `DataSetTrigger` objects
|
1344
1416
|
# @return [Array<Types::DatasetTrigger>]
|
1345
1417
|
#
|
1346
1418
|
# @!attribute [rw] actions
|
1347
|
-
# A list of
|
1419
|
+
# A list of `DataActionSummary` objects.
|
1348
1420
|
# @return [Array<Types::DatasetActionSummary>]
|
1349
1421
|
#
|
1350
1422
|
class DatasetSummary < Struct.new(
|
@@ -1358,8 +1430,8 @@ module Aws::IoTAnalytics
|
|
1358
1430
|
include Aws::Structure
|
1359
1431
|
end
|
1360
1432
|
|
1361
|
-
# The
|
1362
|
-
#
|
1433
|
+
# The `DatasetTrigger` that specifies when the data set is automatically
|
1434
|
+
# updated.
|
1363
1435
|
#
|
1364
1436
|
# @note When making an API call, you may pass DatasetTrigger
|
1365
1437
|
# data as a hash:
|
@@ -1374,7 +1446,7 @@ module Aws::IoTAnalytics
|
|
1374
1446
|
# }
|
1375
1447
|
#
|
1376
1448
|
# @!attribute [rw] schedule
|
1377
|
-
# The
|
1449
|
+
# The Schedule when the trigger is initiated.
|
1378
1450
|
# @return [Types::Schedule]
|
1379
1451
|
#
|
1380
1452
|
# @!attribute [rw] dataset
|
@@ -1396,10 +1468,10 @@ module Aws::IoTAnalytics
|
|
1396
1468
|
# @return [String]
|
1397
1469
|
#
|
1398
1470
|
# @!attribute [rw] storage
|
1399
|
-
# Where data store data is stored. You
|
1400
|
-
#
|
1401
|
-
#
|
1402
|
-
#
|
1471
|
+
# Where data store data is stored. You can choose one of
|
1472
|
+
# `serviceManagedS3` or `customerManagedS3` storage. If not specified,
|
1473
|
+
# the default is `serviceManagedS3`. You cannot change this storage
|
1474
|
+
# option after the data store is created.
|
1403
1475
|
# @return [Types::DatastoreStorage]
|
1404
1476
|
#
|
1405
1477
|
# @!attribute [rw] arn
|
@@ -1424,8 +1496,7 @@ module Aws::IoTAnalytics
|
|
1424
1496
|
#
|
1425
1497
|
# @!attribute [rw] retention_period
|
1426
1498
|
# How long, in days, message data is kept for the data store. When
|
1427
|
-
#
|
1428
|
-
# ignored.
|
1499
|
+
# `customerManagedS3` storage is selected, this parameter is ignored.
|
1429
1500
|
# @return [Types::RetentionPeriod]
|
1430
1501
|
#
|
1431
1502
|
# @!attribute [rw] creation_time
|
@@ -1436,6 +1507,17 @@ module Aws::IoTAnalytics
|
|
1436
1507
|
# The last time the data store was updated.
|
1437
1508
|
# @return [Time]
|
1438
1509
|
#
|
1510
|
+
# @!attribute [rw] last_message_arrival_time
|
1511
|
+
# The last time when a new message arrived in the data store.
|
1512
|
+
#
|
1513
|
+
# AWS IoT Analytics updates this value at most once per minute for one
|
1514
|
+
# data store. Hence, the `lastMessageArrivalTime` value is an
|
1515
|
+
# approximation.
|
1516
|
+
#
|
1517
|
+
# This feature only applies to messages that arrived in the data store
|
1518
|
+
# after October 23, 2020.
|
1519
|
+
# @return [Time]
|
1520
|
+
#
|
1439
1521
|
class Datastore < Struct.new(
|
1440
1522
|
:name,
|
1441
1523
|
:storage,
|
@@ -1443,12 +1525,13 @@ module Aws::IoTAnalytics
|
|
1443
1525
|
:status,
|
1444
1526
|
:retention_period,
|
1445
1527
|
:creation_time,
|
1446
|
-
:last_update_time
|
1528
|
+
:last_update_time,
|
1529
|
+
:last_message_arrival_time)
|
1447
1530
|
SENSITIVE = []
|
1448
1531
|
include Aws::Structure
|
1449
1532
|
end
|
1450
1533
|
|
1451
|
-
# The
|
1534
|
+
# The datastore activity that specifies where to store the processed
|
1452
1535
|
# data.
|
1453
1536
|
#
|
1454
1537
|
# @note When making an API call, you may pass DatastoreActivity
|
@@ -1460,7 +1543,7 @@ module Aws::IoTAnalytics
|
|
1460
1543
|
# }
|
1461
1544
|
#
|
1462
1545
|
# @!attribute [rw] name
|
1463
|
-
# The name of the
|
1546
|
+
# The name of the datastore activity.
|
1464
1547
|
# @return [String]
|
1465
1548
|
#
|
1466
1549
|
# @!attribute [rw] datastore_name
|
@@ -1486,10 +1569,10 @@ module Aws::IoTAnalytics
|
|
1486
1569
|
include Aws::Structure
|
1487
1570
|
end
|
1488
1571
|
|
1489
|
-
# Where data store data is stored. You
|
1490
|
-
#
|
1491
|
-
#
|
1492
|
-
# after the data store is created.
|
1572
|
+
# Where data store data is stored. You can choose one of
|
1573
|
+
# `serviceManagedS3` or `customerManagedS3` storage. If not specified,
|
1574
|
+
# the default is `serviceManagedS3`. You cannot change this storage
|
1575
|
+
# option after the data store is created.
|
1493
1576
|
#
|
1494
1577
|
# @note When making an API call, you may pass DatastoreStorage
|
1495
1578
|
# data as a hash:
|
@@ -1505,15 +1588,14 @@ module Aws::IoTAnalytics
|
|
1505
1588
|
# }
|
1506
1589
|
#
|
1507
1590
|
# @!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.
|
1591
|
+
# Use this to store data store data in an S3 bucket managed by AWS IoT
|
1592
|
+
# Analytics. You cannot change the choice of service-managed or
|
1593
|
+
# customer-managed S3 storage after the data store is created.
|
1512
1594
|
# @return [Types::ServiceManagedDatastoreS3Storage]
|
1513
1595
|
#
|
1514
1596
|
# @!attribute [rw] customer_managed_s3
|
1515
1597
|
# Use this to store data store data in an S3 bucket that you manage.
|
1516
|
-
# When customer managed storage is selected, the
|
1598
|
+
# When customer managed storage is selected, the `retentionPeriod`
|
1517
1599
|
# parameter is ignored. The choice of service-managed or
|
1518
1600
|
# customer-managed S3 storage cannot be changed after creation of the
|
1519
1601
|
# data store.
|
@@ -1529,8 +1611,8 @@ module Aws::IoTAnalytics
|
|
1529
1611
|
# Where data store data is stored.
|
1530
1612
|
#
|
1531
1613
|
# @!attribute [rw] service_managed_s3
|
1532
|
-
# Used to store data store data in an S3 bucket managed by
|
1533
|
-
# Analytics
|
1614
|
+
# Used to store data store data in an S3 bucket managed by AWS IoT
|
1615
|
+
# Analytics.
|
1534
1616
|
# @return [Types::ServiceManagedDatastoreS3StorageSummary]
|
1535
1617
|
#
|
1536
1618
|
# @!attribute [rw] customer_managed_s3
|
@@ -1566,12 +1648,24 @@ module Aws::IoTAnalytics
|
|
1566
1648
|
# The last time the data store was updated.
|
1567
1649
|
# @return [Time]
|
1568
1650
|
#
|
1651
|
+
# @!attribute [rw] last_message_arrival_time
|
1652
|
+
# The last time when a new message arrived in the data store.
|
1653
|
+
#
|
1654
|
+
# AWS IoT Analytics updates this value at most once per minute for one
|
1655
|
+
# data store. Hence, the `lastMessageArrivalTime` value is an
|
1656
|
+
# approximation.
|
1657
|
+
#
|
1658
|
+
# This feature only applies to messages that arrived in the data store
|
1659
|
+
# after October 23, 2020.
|
1660
|
+
# @return [Time]
|
1661
|
+
#
|
1569
1662
|
class DatastoreSummary < Struct.new(
|
1570
1663
|
:datastore_name,
|
1571
1664
|
:datastore_storage,
|
1572
1665
|
:status,
|
1573
1666
|
:creation_time,
|
1574
|
-
:last_update_time
|
1667
|
+
:last_update_time,
|
1668
|
+
:last_message_arrival_time)
|
1575
1669
|
SENSITIVE = []
|
1576
1670
|
include Aws::Structure
|
1577
1671
|
end
|
@@ -1602,11 +1696,11 @@ module Aws::IoTAnalytics
|
|
1602
1696
|
# }
|
1603
1697
|
#
|
1604
1698
|
# @!attribute [rw] dataset_name
|
1605
|
-
# The name of the
|
1699
|
+
# The name of the dataset whose content is deleted.
|
1606
1700
|
# @return [String]
|
1607
1701
|
#
|
1608
1702
|
# @!attribute [rw] version_id
|
1609
|
-
# The version of the
|
1703
|
+
# The version of the dataset whose content is deleted. You can also
|
1610
1704
|
# use the strings "$LATEST" or "$LATEST\_SUCCEEDED" to delete the
|
1611
1705
|
# latest or latest successfully completed data set. If not specified,
|
1612
1706
|
# "$LATEST\_SUCCEEDED" is the default.
|
@@ -1682,22 +1776,21 @@ module Aws::IoTAnalytics
|
|
1682
1776
|
# }
|
1683
1777
|
#
|
1684
1778
|
# @!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.
|
1779
|
+
# The number of seconds of estimated in-flight lag time of message
|
1780
|
+
# data. When you create dataset contents using message data from a
|
1781
|
+
# specified timeframe, some message data might still be in flight when
|
1782
|
+
# processing begins, and so do not arrive in time to be processed. Use
|
1783
|
+
# this field to make allowances for the in flight time of your message
|
1784
|
+
# data, so that data not processed from a previous timeframe is
|
1785
|
+
# included with the next timeframe. Otherwise, missed message data
|
1786
|
+
# would be excluded from processing during the next timeframe too,
|
1787
|
+
# because its timestamp places it within the previous timeframe.
|
1695
1788
|
# @return [Integer]
|
1696
1789
|
#
|
1697
1790
|
# @!attribute [rw] time_expression
|
1698
|
-
# An expression by which the time of the message data
|
1699
|
-
# determined. This
|
1700
|
-
# expression
|
1791
|
+
# An expression by which the time of the message data might be
|
1792
|
+
# determined. This can be the name of a timestamp field or a SQL
|
1793
|
+
# expression that is used to derive the time the message data was
|
1701
1794
|
# generated.
|
1702
1795
|
# @return [String]
|
1703
1796
|
#
|
@@ -1708,6 +1801,48 @@ module Aws::IoTAnalytics
|
|
1708
1801
|
include Aws::Structure
|
1709
1802
|
end
|
1710
1803
|
|
1804
|
+
# A structure that contains the configuration information of a delta
|
1805
|
+
# time session window.
|
1806
|
+
#
|
1807
|
+
# [ `DeltaTime` ][1] specifies a time interval. You can use `DeltaTime`
|
1808
|
+
# to create dataset contents with data that has arrived in the data
|
1809
|
+
# store since the last execution. For an example of `DeltaTime`, see [
|
1810
|
+
# Creating a SQL dataset with a delta window (CLI)][2] in the *AWS IoT
|
1811
|
+
# Analytics User Guide*.
|
1812
|
+
#
|
1813
|
+
#
|
1814
|
+
#
|
1815
|
+
# [1]: https://docs.aws.amazon.com/iotanalytics/latest/APIReference/API_DeltaTime.html
|
1816
|
+
# [2]: https://docs.aws.amazon.com/iotanalytics/latest/userguide/automate-create-dataset.html#automate-example6
|
1817
|
+
#
|
1818
|
+
# @note When making an API call, you may pass DeltaTimeSessionWindowConfiguration
|
1819
|
+
# data as a hash:
|
1820
|
+
#
|
1821
|
+
# {
|
1822
|
+
# timeout_in_minutes: 1, # required
|
1823
|
+
# }
|
1824
|
+
#
|
1825
|
+
# @!attribute [rw] timeout_in_minutes
|
1826
|
+
# A time interval. You can use `timeoutInMinutes` so that AWS IoT
|
1827
|
+
# Analytics can batch up late data notifications that have been
|
1828
|
+
# generated since the last execution. AWS IoT Analytics sends one
|
1829
|
+
# batch of notifications to Amazon CloudWatch Events at one time.
|
1830
|
+
#
|
1831
|
+
# For more information about how to write a timestamp expression, see
|
1832
|
+
# [Date and Time Functions and Operators][1], in the *Presto 0.172
|
1833
|
+
# Documentation*.
|
1834
|
+
#
|
1835
|
+
#
|
1836
|
+
#
|
1837
|
+
# [1]: https://prestodb.io/docs/0.172/functions/datetime.html
|
1838
|
+
# @return [Integer]
|
1839
|
+
#
|
1840
|
+
class DeltaTimeSessionWindowConfiguration < Struct.new(
|
1841
|
+
:timeout_in_minutes)
|
1842
|
+
SENSITIVE = []
|
1843
|
+
include Aws::Structure
|
1844
|
+
end
|
1845
|
+
|
1711
1846
|
# @note When making an API call, you may pass DescribeChannelRequest
|
1712
1847
|
# data as a hash:
|
1713
1848
|
#
|
@@ -1738,8 +1873,8 @@ module Aws::IoTAnalytics
|
|
1738
1873
|
# @return [Types::Channel]
|
1739
1874
|
#
|
1740
1875
|
# @!attribute [rw] statistics
|
1741
|
-
# Statistics about the channel. Included if the
|
1742
|
-
# parameter is set to true in the request.
|
1876
|
+
# Statistics about the channel. Included if the `includeStatistics`
|
1877
|
+
# parameter is set to `true` in the request.
|
1743
1878
|
# @return [Types::ChannelStatistics]
|
1744
1879
|
#
|
1745
1880
|
class DescribeChannelResponse < Struct.new(
|
@@ -1807,7 +1942,7 @@ module Aws::IoTAnalytics
|
|
1807
1942
|
#
|
1808
1943
|
# @!attribute [rw] statistics
|
1809
1944
|
# Additional statistical information about the data store. Included if
|
1810
|
-
# the
|
1945
|
+
# the `includeStatistics` parameter is set to `true` in the request.
|
1811
1946
|
# @return [Types::DatastoreStatistics]
|
1812
1947
|
#
|
1813
1948
|
class DescribeDatastoreResponse < Struct.new(
|
@@ -1849,7 +1984,7 @@ module Aws::IoTAnalytics
|
|
1849
1984
|
end
|
1850
1985
|
|
1851
1986
|
# @!attribute [rw] pipeline
|
1852
|
-
# A
|
1987
|
+
# A `Pipeline` object that contains information about the pipeline.
|
1853
1988
|
# @return [Types::Pipeline]
|
1854
1989
|
#
|
1855
1990
|
class DescribePipelineResponse < Struct.new(
|
@@ -1873,7 +2008,7 @@ module Aws::IoTAnalytics
|
|
1873
2008
|
# }
|
1874
2009
|
#
|
1875
2010
|
# @!attribute [rw] name
|
1876
|
-
# The name of the
|
2011
|
+
# The name of the `deviceRegistryEnrich` activity.
|
1877
2012
|
# @return [String]
|
1878
2013
|
#
|
1879
2014
|
# @!attribute [rw] attribute
|
@@ -1904,7 +2039,7 @@ module Aws::IoTAnalytics
|
|
1904
2039
|
include Aws::Structure
|
1905
2040
|
end
|
1906
2041
|
|
1907
|
-
# An activity that adds information from the AWS IoT Device
|
2042
|
+
# An activity that adds information from the AWS IoT Device Shadow
|
1908
2043
|
# service to a message.
|
1909
2044
|
#
|
1910
2045
|
# @note When making an API call, you may pass DeviceShadowEnrichActivity
|
@@ -1919,7 +2054,7 @@ module Aws::IoTAnalytics
|
|
1919
2054
|
# }
|
1920
2055
|
#
|
1921
2056
|
# @!attribute [rw] name
|
1922
|
-
# The name of the
|
2057
|
+
# The name of the `deviceShadowEnrich` activity.
|
1923
2058
|
# @return [String]
|
1924
2059
|
#
|
1925
2060
|
# @!attribute [rw] attribute
|
@@ -1952,7 +2087,7 @@ module Aws::IoTAnalytics
|
|
1952
2087
|
# The estimated size of the resource.
|
1953
2088
|
#
|
1954
2089
|
# @!attribute [rw] estimated_size_in_bytes
|
1955
|
-
# The estimated size of the resource in bytes.
|
2090
|
+
# The estimated size of the resource, in bytes.
|
1956
2091
|
# @return [Float]
|
1957
2092
|
#
|
1958
2093
|
# @!attribute [rw] estimated_on
|
@@ -1978,12 +2113,13 @@ module Aws::IoTAnalytics
|
|
1978
2113
|
# }
|
1979
2114
|
#
|
1980
2115
|
# @!attribute [rw] name
|
1981
|
-
# The name of the
|
2116
|
+
# The name of the filter activity.
|
1982
2117
|
# @return [String]
|
1983
2118
|
#
|
1984
2119
|
# @!attribute [rw] filter
|
1985
2120
|
# An expression that looks like a SQL WHERE clause that must return a
|
1986
|
-
# Boolean value.
|
2121
|
+
# Boolean value. Messages that satisfy the condition are passed to the
|
2122
|
+
# next activity.
|
1987
2123
|
# @return [String]
|
1988
2124
|
#
|
1989
2125
|
# @!attribute [rw] next
|
@@ -2025,7 +2161,7 @@ module Aws::IoTAnalytics
|
|
2025
2161
|
end
|
2026
2162
|
|
2027
2163
|
# @!attribute [rw] entries
|
2028
|
-
# A list of
|
2164
|
+
# A list of `DatasetEntry` objects.
|
2029
2165
|
# @return [Array<Types::DatasetEntry>]
|
2030
2166
|
#
|
2031
2167
|
# @!attribute [rw] timestamp
|
@@ -2044,8 +2180,8 @@ module Aws::IoTAnalytics
|
|
2044
2180
|
include Aws::Structure
|
2045
2181
|
end
|
2046
2182
|
|
2047
|
-
# Configuration information for coordination with
|
2048
|
-
#
|
2183
|
+
# Configuration information for coordination with AWS Glue, a fully
|
2184
|
+
# managed extract, transform and load (ETL) service.
|
2049
2185
|
#
|
2050
2186
|
# @note When making an API call, you may pass GlueConfiguration
|
2051
2187
|
# data as a hash:
|
@@ -2056,16 +2192,15 @@ module Aws::IoTAnalytics
|
|
2056
2192
|
# }
|
2057
2193
|
#
|
2058
2194
|
# @!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.)
|
2195
|
+
# The name of the table in your AWS Glue Data Catalog that is used to
|
2196
|
+
# perform the ETL operations. An AWS Glue Data Catalog table contains
|
2197
|
+
# partitioned data and descriptions of data sources and targets.
|
2063
2198
|
# @return [String]
|
2064
2199
|
#
|
2065
2200
|
# @!attribute [rw] database_name
|
2066
2201
|
# The name of the database in your AWS Glue Data Catalog in which the
|
2067
|
-
# table is located.
|
2068
|
-
#
|
2202
|
+
# table is located. An AWS Glue Data Catalog database contains
|
2203
|
+
# metadata tables.
|
2069
2204
|
# @return [String]
|
2070
2205
|
#
|
2071
2206
|
class GlueConfiguration < Struct.new(
|
@@ -2097,7 +2232,7 @@ module Aws::IoTAnalytics
|
|
2097
2232
|
include Aws::Structure
|
2098
2233
|
end
|
2099
2234
|
|
2100
|
-
# Configuration information for delivery of
|
2235
|
+
# Configuration information for delivery of dataset contents to AWS IoT
|
2101
2236
|
# Events.
|
2102
2237
|
#
|
2103
2238
|
# @note When making an API call, you may pass IotEventsDestinationConfiguration
|
@@ -2109,13 +2244,13 @@ module Aws::IoTAnalytics
|
|
2109
2244
|
# }
|
2110
2245
|
#
|
2111
2246
|
# @!attribute [rw] input_name
|
2112
|
-
# The name of the AWS IoT Events input to which
|
2247
|
+
# The name of the AWS IoT Events input to which dataset contents are
|
2113
2248
|
# delivered.
|
2114
2249
|
# @return [String]
|
2115
2250
|
#
|
2116
2251
|
# @!attribute [rw] role_arn
|
2117
|
-
# The ARN of the role
|
2118
|
-
# deliver
|
2252
|
+
# The ARN of the role that grants AWS IoT Analytics permission to
|
2253
|
+
# deliver dataset contents to an AWS IoT Events input.
|
2119
2254
|
# @return [String]
|
2120
2255
|
#
|
2121
2256
|
class IotEventsDestinationConfiguration < Struct.new(
|
@@ -2138,7 +2273,7 @@ module Aws::IoTAnalytics
|
|
2138
2273
|
# }
|
2139
2274
|
#
|
2140
2275
|
# @!attribute [rw] name
|
2141
|
-
# The name of the
|
2276
|
+
# The name of the lambda activity.
|
2142
2277
|
# @return [String]
|
2143
2278
|
#
|
2144
2279
|
# @!attribute [rw] lambda_name
|
@@ -2148,9 +2283,9 @@ module Aws::IoTAnalytics
|
|
2148
2283
|
# @!attribute [rw] batch_size
|
2149
2284
|
# The number of messages passed to the Lambda function for processing.
|
2150
2285
|
#
|
2151
|
-
# The
|
2152
|
-
#
|
2153
|
-
#
|
2286
|
+
# The Lambda function must be able to process all of these messages
|
2287
|
+
# within five minutes, which is the maximum timeout duration for
|
2288
|
+
# Lambda functions.
|
2154
2289
|
# @return [Integer]
|
2155
2290
|
#
|
2156
2291
|
# @!attribute [rw] next
|
@@ -2166,6 +2301,57 @@ module Aws::IoTAnalytics
|
|
2166
2301
|
include Aws::Structure
|
2167
2302
|
end
|
2168
2303
|
|
2304
|
+
# A structure that contains the name and configuration information of a
|
2305
|
+
# late data rule.
|
2306
|
+
#
|
2307
|
+
# @note When making an API call, you may pass LateDataRule
|
2308
|
+
# data as a hash:
|
2309
|
+
#
|
2310
|
+
# {
|
2311
|
+
# rule_name: "LateDataRuleName",
|
2312
|
+
# rule_configuration: { # required
|
2313
|
+
# delta_time_session_window_configuration: {
|
2314
|
+
# timeout_in_minutes: 1, # required
|
2315
|
+
# },
|
2316
|
+
# },
|
2317
|
+
# }
|
2318
|
+
#
|
2319
|
+
# @!attribute [rw] rule_name
|
2320
|
+
# The name of the late data rule.
|
2321
|
+
# @return [String]
|
2322
|
+
#
|
2323
|
+
# @!attribute [rw] rule_configuration
|
2324
|
+
# The information needed to configure the late data rule.
|
2325
|
+
# @return [Types::LateDataRuleConfiguration]
|
2326
|
+
#
|
2327
|
+
class LateDataRule < Struct.new(
|
2328
|
+
:rule_name,
|
2329
|
+
:rule_configuration)
|
2330
|
+
SENSITIVE = []
|
2331
|
+
include Aws::Structure
|
2332
|
+
end
|
2333
|
+
|
2334
|
+
# The information needed to configure a delta time session window.
|
2335
|
+
#
|
2336
|
+
# @note When making an API call, you may pass LateDataRuleConfiguration
|
2337
|
+
# data as a hash:
|
2338
|
+
#
|
2339
|
+
# {
|
2340
|
+
# delta_time_session_window_configuration: {
|
2341
|
+
# timeout_in_minutes: 1, # required
|
2342
|
+
# },
|
2343
|
+
# }
|
2344
|
+
#
|
2345
|
+
# @!attribute [rw] delta_time_session_window_configuration
|
2346
|
+
# The information needed to configure a delta time session window.
|
2347
|
+
# @return [Types::DeltaTimeSessionWindowConfiguration]
|
2348
|
+
#
|
2349
|
+
class LateDataRuleConfiguration < Struct.new(
|
2350
|
+
:delta_time_session_window_configuration)
|
2351
|
+
SENSITIVE = []
|
2352
|
+
include Aws::Structure
|
2353
|
+
end
|
2354
|
+
|
2169
2355
|
# The command caused an internal limit to be exceeded.
|
2170
2356
|
#
|
2171
2357
|
# @!attribute [rw] message
|
@@ -2203,7 +2389,7 @@ module Aws::IoTAnalytics
|
|
2203
2389
|
end
|
2204
2390
|
|
2205
2391
|
# @!attribute [rw] channel_summaries
|
2206
|
-
# A list of
|
2392
|
+
# A list of `ChannelSummary` objects.
|
2207
2393
|
# @return [Array<Types::ChannelSummary>]
|
2208
2394
|
#
|
2209
2395
|
# @!attribute [rw] next_token
|
@@ -2245,13 +2431,13 @@ module Aws::IoTAnalytics
|
|
2245
2431
|
# @!attribute [rw] scheduled_on_or_after
|
2246
2432
|
# A filter to limit results to those data set contents whose creation
|
2247
2433
|
# is scheduled on or after the given time. See the field
|
2248
|
-
# `triggers.schedule` in the CreateDataset request. (timestamp)
|
2434
|
+
# `triggers.schedule` in the `CreateDataset` request. (timestamp)
|
2249
2435
|
# @return [Time]
|
2250
2436
|
#
|
2251
2437
|
# @!attribute [rw] scheduled_before
|
2252
2438
|
# A filter to limit results to those data set contents whose creation
|
2253
2439
|
# is scheduled before the given time. See the field
|
2254
|
-
# `triggers.schedule` in the CreateDataset request. (timestamp)
|
2440
|
+
# `triggers.schedule` in the `CreateDataset` request. (timestamp)
|
2255
2441
|
# @return [Time]
|
2256
2442
|
#
|
2257
2443
|
class ListDatasetContentsRequest < Struct.new(
|
@@ -2306,7 +2492,7 @@ module Aws::IoTAnalytics
|
|
2306
2492
|
end
|
2307
2493
|
|
2308
2494
|
# @!attribute [rw] dataset_summaries
|
2309
|
-
# A list of
|
2495
|
+
# A list of `DatasetSummary` objects.
|
2310
2496
|
# @return [Array<Types::DatasetSummary>]
|
2311
2497
|
#
|
2312
2498
|
# @!attribute [rw] next_token
|
@@ -2347,7 +2533,7 @@ module Aws::IoTAnalytics
|
|
2347
2533
|
end
|
2348
2534
|
|
2349
2535
|
# @!attribute [rw] datastore_summaries
|
2350
|
-
# A list of
|
2536
|
+
# A list of `DatastoreSummary` objects.
|
2351
2537
|
# @return [Array<Types::DatastoreSummary>]
|
2352
2538
|
#
|
2353
2539
|
# @!attribute [rw] next_token
|
@@ -2388,7 +2574,7 @@ module Aws::IoTAnalytics
|
|
2388
2574
|
end
|
2389
2575
|
|
2390
2576
|
# @!attribute [rw] pipeline_summaries
|
2391
|
-
# A list of
|
2577
|
+
# A list of `PipelineSummary` objects.
|
2392
2578
|
# @return [Array<Types::PipelineSummary>]
|
2393
2579
|
#
|
2394
2580
|
# @!attribute [rw] next_token
|
@@ -2421,7 +2607,7 @@ module Aws::IoTAnalytics
|
|
2421
2607
|
end
|
2422
2608
|
|
2423
2609
|
# @!attribute [rw] tags
|
2424
|
-
# The tags (metadata)
|
2610
|
+
# The tags (metadata) that you have assigned to the resource.
|
2425
2611
|
# @return [Array<Types::Tag>]
|
2426
2612
|
#
|
2427
2613
|
class ListTagsForResourceResponse < Struct.new(
|
@@ -2447,7 +2633,7 @@ module Aws::IoTAnalytics
|
|
2447
2633
|
# @return [String]
|
2448
2634
|
#
|
2449
2635
|
# @!attribute [rw] level
|
2450
|
-
# The logging level. Currently, only
|
2636
|
+
# The logging level. Currently, only ERROR is supported.
|
2451
2637
|
# @return [String]
|
2452
2638
|
#
|
2453
2639
|
# @!attribute [rw] enabled
|
@@ -2476,7 +2662,7 @@ module Aws::IoTAnalytics
|
|
2476
2662
|
# }
|
2477
2663
|
#
|
2478
2664
|
# @!attribute [rw] name
|
2479
|
-
# The name of the
|
2665
|
+
# The name of the math activity.
|
2480
2666
|
# @return [String]
|
2481
2667
|
#
|
2482
2668
|
# @!attribute [rw] attribute
|
@@ -2513,14 +2699,14 @@ module Aws::IoTAnalytics
|
|
2513
2699
|
# }
|
2514
2700
|
#
|
2515
2701
|
# @!attribute [rw] message_id
|
2516
|
-
# The ID you
|
2702
|
+
# The ID you want to assign to the message. Each `messageId` must be
|
2517
2703
|
# unique within each batch sent.
|
2518
2704
|
# @return [String]
|
2519
2705
|
#
|
2520
2706
|
# @!attribute [rw] payload
|
2521
|
-
# The payload of the message. This
|
2522
|
-
#
|
2523
|
-
# must decode it by means of a pipeline activity
|
2707
|
+
# The payload of the message. This can be a JSON string or a
|
2708
|
+
# base64-encoded string representing binary data, in which case you
|
2709
|
+
# must decode it by means of a pipeline activity.
|
2524
2710
|
# @return [String]
|
2525
2711
|
#
|
2526
2712
|
class Message < Struct.new(
|
@@ -2541,7 +2727,7 @@ module Aws::IoTAnalytics
|
|
2541
2727
|
# }
|
2542
2728
|
#
|
2543
2729
|
# @!attribute [rw] file_name
|
2544
|
-
# The URI of the location where
|
2730
|
+
# The URI of the location where dataset contents are stored, usually
|
2545
2731
|
# the URI of a file in an S3 bucket.
|
2546
2732
|
# @return [String]
|
2547
2733
|
#
|
@@ -2692,7 +2878,7 @@ module Aws::IoTAnalytics
|
|
2692
2878
|
# @return [Types::DeviceRegistryEnrichActivity]
|
2693
2879
|
#
|
2694
2880
|
# @!attribute [rw] device_shadow_enrich
|
2695
|
-
# Adds information from the AWS IoT Device
|
2881
|
+
# Adds information from the AWS IoT Device Shadow service to a
|
2696
2882
|
# message.
|
2697
2883
|
# @return [Types::DeviceShadowEnrichActivity]
|
2698
2884
|
#
|
@@ -2759,8 +2945,8 @@ module Aws::IoTAnalytics
|
|
2759
2945
|
include Aws::Structure
|
2760
2946
|
end
|
2761
2947
|
|
2762
|
-
# Information
|
2763
|
-
# according to the
|
2948
|
+
# Information that is used to filter message data, to segregate it
|
2949
|
+
# according to the timeframe in which it arrives.
|
2764
2950
|
#
|
2765
2951
|
# @note When making an API call, you may pass QueryFilter
|
2766
2952
|
# data as a hash:
|
@@ -2795,7 +2981,7 @@ module Aws::IoTAnalytics
|
|
2795
2981
|
# }
|
2796
2982
|
#
|
2797
2983
|
# @!attribute [rw] name
|
2798
|
-
# The name of the
|
2984
|
+
# The name of the `removeAttributes` activity.
|
2799
2985
|
# @return [String]
|
2800
2986
|
#
|
2801
2987
|
# @!attribute [rw] attributes
|
@@ -2817,7 +3003,7 @@ module Aws::IoTAnalytics
|
|
2817
3003
|
# Information about pipeline reprocessing.
|
2818
3004
|
#
|
2819
3005
|
# @!attribute [rw] id
|
2820
|
-
# The
|
3006
|
+
# The `reprocessingId` returned by `StartPipelineReprocessing`.
|
2821
3007
|
# @return [String]
|
2822
3008
|
#
|
2823
3009
|
# @!attribute [rw] status
|
@@ -2858,7 +3044,7 @@ module Aws::IoTAnalytics
|
|
2858
3044
|
end
|
2859
3045
|
|
2860
3046
|
# The configuration of the resource used to execute the
|
2861
|
-
#
|
3047
|
+
# `containerAction`.
|
2862
3048
|
#
|
2863
3049
|
# @note When making an API call, you may pass ResourceConfiguration
|
2864
3050
|
# data as a hash:
|
@@ -2870,13 +3056,13 @@ module Aws::IoTAnalytics
|
|
2870
3056
|
#
|
2871
3057
|
# @!attribute [rw] compute_type
|
2872
3058
|
# The type of the compute resource used to execute the
|
2873
|
-
#
|
2874
|
-
#
|
3059
|
+
# `containerAction`. Possible values are: `ACU_1` (vCPU=4, memory=16
|
3060
|
+
# GiB) or `ACU_2` (vCPU=8, memory=32 GiB).
|
2875
3061
|
# @return [String]
|
2876
3062
|
#
|
2877
3063
|
# @!attribute [rw] volume_size_in_gb
|
2878
|
-
# The size
|
2879
|
-
# instance used to execute the
|
3064
|
+
# The size, in GB, of the persistent storage available to the resource
|
3065
|
+
# instance used to execute the `containerAction` (min: 1, max: 50).
|
2880
3066
|
# @return [Integer]
|
2881
3067
|
#
|
2882
3068
|
class ResourceConfiguration < Struct.new(
|
@@ -2912,7 +3098,7 @@ module Aws::IoTAnalytics
|
|
2912
3098
|
# @return [Boolean]
|
2913
3099
|
#
|
2914
3100
|
# @!attribute [rw] number_of_days
|
2915
|
-
# The number of days that message data is kept. The
|
3101
|
+
# The number of days that message data is kept. The `unlimited`
|
2916
3102
|
# parameter must be false.
|
2917
3103
|
# @return [Integer]
|
2918
3104
|
#
|
@@ -2990,12 +3176,12 @@ module Aws::IoTAnalytics
|
|
2990
3176
|
# }
|
2991
3177
|
#
|
2992
3178
|
# @!attribute [rw] pipeline_activity
|
2993
|
-
# The pipeline activity that is run. This must not be a
|
2994
|
-
# activity or a
|
2995
|
-
#
|
2996
|
-
#
|
2997
|
-
#
|
2998
|
-
#
|
3179
|
+
# The pipeline activity that is run. This must not be a channel
|
3180
|
+
# activity or a datastore activity because these activities are used
|
3181
|
+
# in a pipeline only to load the original message and to store the
|
3182
|
+
# (possibly) transformed message. If a lambda activity is specified,
|
3183
|
+
# only short-running Lambda functions (those with a timeout of less
|
3184
|
+
# than 30 seconds or less) can be used.
|
2999
3185
|
# @return [Types::PipelineActivity]
|
3000
3186
|
#
|
3001
3187
|
# @!attribute [rw] payloads
|
@@ -3027,8 +3213,8 @@ module Aws::IoTAnalytics
|
|
3027
3213
|
include Aws::Structure
|
3028
3214
|
end
|
3029
3215
|
|
3030
|
-
# Configuration information for delivery of
|
3031
|
-
# S3.
|
3216
|
+
# Configuration information for delivery of dataset contents to Amazon
|
3217
|
+
# Simple Storage Service (Amazon S3).
|
3032
3218
|
#
|
3033
3219
|
# @note When making an API call, you may pass S3DestinationConfiguration
|
3034
3220
|
# data as a hash:
|
@@ -3044,28 +3230,44 @@ module Aws::IoTAnalytics
|
|
3044
3230
|
# }
|
3045
3231
|
#
|
3046
3232
|
# @!attribute [rw] bucket
|
3047
|
-
# The name of the
|
3048
|
-
# delivered.
|
3233
|
+
# The name of the S3 bucket to which dataset contents are delivered.
|
3049
3234
|
# @return [String]
|
3050
3235
|
#
|
3051
3236
|
# @!attribute [rw] key
|
3052
|
-
# The key of the
|
3053
|
-
#
|
3054
|
-
#
|
3055
|
-
#
|
3056
|
-
#
|
3057
|
-
#
|
3058
|
-
# the
|
3059
|
-
#
|
3237
|
+
# The key of the dataset contents object in an S3 bucket. Each object
|
3238
|
+
# has a key that is a unique identifier. Each object has exactly one
|
3239
|
+
# key.
|
3240
|
+
#
|
3241
|
+
# You can create a unique key with the following options:
|
3242
|
+
#
|
3243
|
+
# * Use `!\{iotanalytics:scheduleTime\}` to insert the time of a
|
3244
|
+
# scheduled SQL query run.
|
3245
|
+
#
|
3246
|
+
# * Use `!\{iotanalytics:versionId\}` to insert a unique hash that
|
3247
|
+
# identifies a dataset content.
|
3248
|
+
#
|
3249
|
+
# * Use `!\{iotanalytics:creationTime\}` to insert the creation time
|
3250
|
+
# of a dataset content.
|
3251
|
+
#
|
3252
|
+
# The following example creates a unique key for a CSV file:
|
3253
|
+
# `dataset/mydataset/!\{iotanalytics:scheduleTime\}/!\{iotanalytics:versionId\}.csv`
|
3254
|
+
#
|
3255
|
+
# <note markdown="1"> If you don't use `!\{iotanalytics:versionId\}` to specify the key,
|
3256
|
+
# you might get duplicate keys. For example, you might have two
|
3257
|
+
# dataset contents with the same `scheduleTime` but different
|
3258
|
+
# `versionId`s. This means that one dataset content overwrites the
|
3259
|
+
# other.
|
3260
|
+
#
|
3261
|
+
# </note>
|
3060
3262
|
# @return [String]
|
3061
3263
|
#
|
3062
3264
|
# @!attribute [rw] glue_configuration
|
3063
|
-
# Configuration information for coordination with
|
3064
|
-
#
|
3265
|
+
# Configuration information for coordination with AWS Glue, a fully
|
3266
|
+
# managed extract, transform and load (ETL) service.
|
3065
3267
|
# @return [Types::GlueConfiguration]
|
3066
3268
|
#
|
3067
3269
|
# @!attribute [rw] role_arn
|
3068
|
-
# The ARN of the role
|
3270
|
+
# The ARN of the role that grants AWS IoT Analytics permission to
|
3069
3271
|
# interact with your Amazon S3 and AWS Glue resources.
|
3070
3272
|
# @return [String]
|
3071
3273
|
#
|
@@ -3093,7 +3295,7 @@ module Aws::IoTAnalytics
|
|
3093
3295
|
# @return [String]
|
3094
3296
|
#
|
3095
3297
|
# @!attribute [rw] max_messages
|
3096
|
-
# The number of sample messages to be retrieved. The limit is 10
|
3298
|
+
# The number of sample messages to be retrieved. The limit is 10. The
|
3097
3299
|
# default is also 10.
|
3098
3300
|
# @return [Integer]
|
3099
3301
|
#
|
@@ -3137,8 +3339,8 @@ module Aws::IoTAnalytics
|
|
3137
3339
|
#
|
3138
3340
|
# @!attribute [rw] expression
|
3139
3341
|
# The expression that defines when to trigger an update. For more
|
3140
|
-
# information, see [
|
3141
|
-
# CloudWatch Events User Guide
|
3342
|
+
# information, see [Schedule Expressions for Rules][1] in the *Amazon
|
3343
|
+
# CloudWatch Events User Guide*.
|
3142
3344
|
#
|
3143
3345
|
#
|
3144
3346
|
#
|
@@ -3164,7 +3366,7 @@ module Aws::IoTAnalytics
|
|
3164
3366
|
# }
|
3165
3367
|
#
|
3166
3368
|
# @!attribute [rw] name
|
3167
|
-
# The name of the
|
3369
|
+
# The name of the `selectAttributes` activity.
|
3168
3370
|
# @return [String]
|
3169
3371
|
#
|
3170
3372
|
# @!attribute [rw] attributes
|
@@ -3183,30 +3385,29 @@ module Aws::IoTAnalytics
|
|
3183
3385
|
include Aws::Structure
|
3184
3386
|
end
|
3185
3387
|
|
3186
|
-
# Use this to store channel data in an S3 bucket managed by
|
3187
|
-
# Analytics
|
3188
|
-
# S3 storage
|
3388
|
+
# Use this to store channel data in an S3 bucket managed by AWS IoT
|
3389
|
+
# Analytics. You cannot change the choice of service-managed or
|
3390
|
+
# customer-managed S3 storage after the channel is created.
|
3189
3391
|
#
|
3190
3392
|
# @api private
|
3191
3393
|
#
|
3192
3394
|
class ServiceManagedChannelS3Storage < Aws::EmptyStructure; end
|
3193
3395
|
|
3194
|
-
# Used to store channel data in an S3 bucket managed by
|
3195
|
-
# Analytics
|
3396
|
+
# Used to store channel data in an S3 bucket managed by AWS IoT
|
3397
|
+
# Analytics.
|
3196
3398
|
#
|
3197
3399
|
class ServiceManagedChannelS3StorageSummary < Aws::EmptyStructure; end
|
3198
3400
|
|
3199
|
-
# Use this to store data store data in an S3 bucket managed by
|
3200
|
-
#
|
3201
|
-
# customer-managed S3 storage
|
3202
|
-
# data store.
|
3401
|
+
# Use this to store data store data in an S3 bucket managed by AWS IoT
|
3402
|
+
# Analytics. You cannot change the choice of service-managed or
|
3403
|
+
# customer-managed S3 storage after the data store is created.
|
3203
3404
|
#
|
3204
3405
|
# @api private
|
3205
3406
|
#
|
3206
3407
|
class ServiceManagedDatastoreS3Storage < Aws::EmptyStructure; end
|
3207
3408
|
|
3208
|
-
# Used to store data store data in an S3 bucket managed by
|
3209
|
-
# Analytics
|
3409
|
+
# Used to store data store data in an S3 bucket managed by AWS IoT
|
3410
|
+
# Analytics.
|
3210
3411
|
#
|
3211
3412
|
class ServiceManagedDatastoreS3StorageSummary < Aws::EmptyStructure; end
|
3212
3413
|
|
@@ -3243,7 +3444,7 @@ module Aws::IoTAnalytics
|
|
3243
3444
|
# @return [String]
|
3244
3445
|
#
|
3245
3446
|
# @!attribute [rw] filters
|
3246
|
-
#
|
3447
|
+
# Prefilters applied to message data.
|
3247
3448
|
# @return [Array<Types::QueryFilter>]
|
3248
3449
|
#
|
3249
3450
|
class SqlQueryDatasetAction < Struct.new(
|
@@ -3292,7 +3493,7 @@ module Aws::IoTAnalytics
|
|
3292
3493
|
include Aws::Structure
|
3293
3494
|
end
|
3294
3495
|
|
3295
|
-
# A set of key
|
3496
|
+
# A set of key-value pairs that are used to manage the resource.
|
3296
3497
|
#
|
3297
3498
|
# @note When making an API call, you may pass Tag
|
3298
3499
|
# data as a hash:
|
@@ -3358,8 +3559,8 @@ module Aws::IoTAnalytics
|
|
3358
3559
|
include Aws::Structure
|
3359
3560
|
end
|
3360
3561
|
|
3361
|
-
# Information about the
|
3362
|
-
# new
|
3562
|
+
# Information about the dataset whose content generation triggers the
|
3563
|
+
# new dataset content generation.
|
3363
3564
|
#
|
3364
3565
|
# @note When making an API call, you may pass TriggeringDataset
|
3365
3566
|
# data as a hash:
|
@@ -3369,8 +3570,8 @@ module Aws::IoTAnalytics
|
|
3369
3570
|
# }
|
3370
3571
|
#
|
3371
3572
|
# @!attribute [rw] name
|
3372
|
-
# The name of the
|
3373
|
-
#
|
3573
|
+
# The name of the dataset whose content generation triggers the new
|
3574
|
+
# dataset content generation.
|
3374
3575
|
# @return [String]
|
3375
3576
|
#
|
3376
3577
|
class TriggeringDataset < Struct.new(
|
@@ -3429,10 +3630,10 @@ module Aws::IoTAnalytics
|
|
3429
3630
|
# @return [String]
|
3430
3631
|
#
|
3431
3632
|
# @!attribute [rw] channel_storage
|
3432
|
-
# Where channel data is stored. You
|
3433
|
-
#
|
3434
|
-
#
|
3435
|
-
#
|
3633
|
+
# Where channel data is stored. You can choose one of
|
3634
|
+
# `serviceManagedS3` or `customerManagedS3` storage. If not specified,
|
3635
|
+
# the default is `serviceManagedS3`. You cannot change this storage
|
3636
|
+
# option after the channel is created.
|
3436
3637
|
# @return [Types::ChannelStorage]
|
3437
3638
|
#
|
3438
3639
|
# @!attribute [rw] retention_period
|
@@ -3529,6 +3730,16 @@ module Aws::IoTAnalytics
|
|
3529
3730
|
# unlimited: false,
|
3530
3731
|
# max_versions: 1,
|
3531
3732
|
# },
|
3733
|
+
# late_data_rules: [
|
3734
|
+
# {
|
3735
|
+
# rule_name: "LateDataRuleName",
|
3736
|
+
# rule_configuration: { # required
|
3737
|
+
# delta_time_session_window_configuration: {
|
3738
|
+
# timeout_in_minutes: 1, # required
|
3739
|
+
# },
|
3740
|
+
# },
|
3741
|
+
# },
|
3742
|
+
# ],
|
3532
3743
|
# }
|
3533
3744
|
#
|
3534
3745
|
# @!attribute [rw] dataset_name
|
@@ -3536,39 +3747,54 @@ module Aws::IoTAnalytics
|
|
3536
3747
|
# @return [String]
|
3537
3748
|
#
|
3538
3749
|
# @!attribute [rw] actions
|
3539
|
-
# A list of
|
3750
|
+
# A list of `DatasetAction` objects.
|
3540
3751
|
# @return [Array<Types::DatasetAction>]
|
3541
3752
|
#
|
3542
3753
|
# @!attribute [rw] triggers
|
3543
|
-
# A list of
|
3544
|
-
# contain up to five
|
3754
|
+
# A list of `DatasetTrigger` objects. The list can be empty or can
|
3755
|
+
# contain up to five `DatasetTrigger` objects.
|
3545
3756
|
# @return [Array<Types::DatasetTrigger>]
|
3546
3757
|
#
|
3547
3758
|
# @!attribute [rw] content_delivery_rules
|
3548
|
-
# When
|
3759
|
+
# When dataset contents are created, they are delivered to
|
3549
3760
|
# destinations specified here.
|
3550
3761
|
# @return [Array<Types::DatasetContentDeliveryRule>]
|
3551
3762
|
#
|
3552
3763
|
# @!attribute [rw] retention_period
|
3553
|
-
# How long, in days,
|
3764
|
+
# How long, in days, dataset contents are kept for the dataset.
|
3554
3765
|
# @return [Types::RetentionPeriod]
|
3555
3766
|
#
|
3556
3767
|
# @!attribute [rw] versioning_configuration
|
3557
|
-
#
|
3768
|
+
# Optional. How many versions of dataset contents are kept. If not
|
3558
3769
|
# specified or set to null, only the latest version plus the latest
|
3559
3770
|
# succeeded version (if they are different) are kept for the time
|
3560
|
-
# period specified by the
|
3561
|
-
# information, see
|
3562
|
-
#
|
3771
|
+
# period specified by the `retentionPeriod` parameter. For more
|
3772
|
+
# information, see [Keeping Multiple Versions of AWS IoT Analytics
|
3773
|
+
# Data Sets][1] in the *AWS IoT Analytics User Guide*.
|
3774
|
+
#
|
3775
|
+
#
|
3776
|
+
#
|
3777
|
+
# [1]: https://docs.aws.amazon.com/iotanalytics/latest/userguide/getting-started.html#aws-iot-analytics-dataset-versions
|
3563
3778
|
# @return [Types::VersioningConfiguration]
|
3564
3779
|
#
|
3780
|
+
# @!attribute [rw] late_data_rules
|
3781
|
+
# A list of data rules that send notifications to Amazon CloudWatch,
|
3782
|
+
# when data arrives late. To specify `lateDataRules`, the dataset must
|
3783
|
+
# use a [DeltaTimer][1] filter.
|
3784
|
+
#
|
3785
|
+
#
|
3786
|
+
#
|
3787
|
+
# [1]: https://docs.aws.amazon.com/iotanalytics/latest/APIReference/API_DeltaTime.html
|
3788
|
+
# @return [Array<Types::LateDataRule>]
|
3789
|
+
#
|
3565
3790
|
class UpdateDatasetRequest < Struct.new(
|
3566
3791
|
:dataset_name,
|
3567
3792
|
:actions,
|
3568
3793
|
:triggers,
|
3569
3794
|
:content_delivery_rules,
|
3570
3795
|
:retention_period,
|
3571
|
-
:versioning_configuration
|
3796
|
+
:versioning_configuration,
|
3797
|
+
:late_data_rules)
|
3572
3798
|
SENSITIVE = []
|
3573
3799
|
include Aws::Structure
|
3574
3800
|
end
|
@@ -3604,10 +3830,10 @@ module Aws::IoTAnalytics
|
|
3604
3830
|
# @return [Types::RetentionPeriod]
|
3605
3831
|
#
|
3606
3832
|
# @!attribute [rw] datastore_storage
|
3607
|
-
# Where data store data is stored. You
|
3608
|
-
#
|
3609
|
-
#
|
3610
|
-
#
|
3833
|
+
# Where data store data is stored. You can choose one of
|
3834
|
+
# `serviceManagedS3` or `customerManagedS3` storage. If not specified,
|
3835
|
+
# the default is`serviceManagedS3`. You cannot change this storage
|
3836
|
+
# option after the data store is created.
|
3611
3837
|
# @return [Types::DatastoreStorage]
|
3612
3838
|
#
|
3613
3839
|
class UpdateDatastoreRequest < Struct.new(
|
@@ -3691,16 +3917,16 @@ module Aws::IoTAnalytics
|
|
3691
3917
|
# @return [String]
|
3692
3918
|
#
|
3693
3919
|
# @!attribute [rw] pipeline_activities
|
3694
|
-
# A list of
|
3920
|
+
# A list of `PipelineActivity` objects. Activities perform
|
3695
3921
|
# transformations on your messages, such as removing, renaming or
|
3696
3922
|
# adding message attributes; filtering messages based on attribute
|
3697
3923
|
# values; invoking your Lambda functions on messages for advanced
|
3698
3924
|
# processing; or performing mathematical transformations to normalize
|
3699
3925
|
# device data.
|
3700
3926
|
#
|
3701
|
-
# The list can be 2-25
|
3927
|
+
# The list can be 2-25 `PipelineActivity` objects and must contain
|
3702
3928
|
# both a `channel` and a `datastore` activity. Each entry in the list
|
3703
|
-
# must contain only one activity
|
3929
|
+
# must contain only one activity. For example:
|
3704
3930
|
#
|
3705
3931
|
# `pipelineActivities = [ \{ "channel": \{ ... \} \}, \{ "lambda": \{
|
3706
3932
|
# ... \} \}, ... ]`
|
@@ -3713,10 +3939,9 @@ module Aws::IoTAnalytics
|
|
3713
3939
|
include Aws::Structure
|
3714
3940
|
end
|
3715
3941
|
|
3716
|
-
# An instance of a variable to be passed to the
|
3942
|
+
# An instance of a variable to be passed to the `containerAction`
|
3717
3943
|
# execution. Each variable must have a name and a value given by one of
|
3718
|
-
#
|
3719
|
-
# "outputFileUriValue".
|
3944
|
+
# `stringValue`, `datasetContentVersionValue`, or `outputFileUriValue`.
|
3720
3945
|
#
|
3721
3946
|
# @note When making an API call, you may pass Variable
|
3722
3947
|
# data as a hash:
|
@@ -3746,7 +3971,7 @@ module Aws::IoTAnalytics
|
|
3746
3971
|
# @return [Float]
|
3747
3972
|
#
|
3748
3973
|
# @!attribute [rw] dataset_content_version_value
|
3749
|
-
# The value of the variable as a structure that specifies a
|
3974
|
+
# The value of the variable as a structure that specifies a dataset
|
3750
3975
|
# content version.
|
3751
3976
|
# @return [Types::DatasetContentVersionValue]
|
3752
3977
|
#
|
@@ -3765,7 +3990,7 @@ module Aws::IoTAnalytics
|
|
3765
3990
|
include Aws::Structure
|
3766
3991
|
end
|
3767
3992
|
|
3768
|
-
# Information about the versioning of
|
3993
|
+
# Information about the versioning of dataset contents.
|
3769
3994
|
#
|
3770
3995
|
# @note When making an API call, you may pass VersioningConfiguration
|
3771
3996
|
# data as a hash:
|
@@ -3776,12 +4001,12 @@ module Aws::IoTAnalytics
|
|
3776
4001
|
# }
|
3777
4002
|
#
|
3778
4003
|
# @!attribute [rw] unlimited
|
3779
|
-
# If true, unlimited versions of
|
4004
|
+
# If true, unlimited versions of dataset contents are kept.
|
3780
4005
|
# @return [Boolean]
|
3781
4006
|
#
|
3782
4007
|
# @!attribute [rw] max_versions
|
3783
|
-
# How many versions of
|
3784
|
-
#
|
4008
|
+
# How many versions of dataset contents are kept. The `unlimited`
|
4009
|
+
# parameter must be `false`.
|
3785
4010
|
# @return [Integer]
|
3786
4011
|
#
|
3787
4012
|
class VersioningConfiguration < Struct.new(
|