aws-sdk-iotanalytics 1.30.1 → 1.35.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 +5 -2
- data/lib/aws-sdk-iotanalytics/client.rb +181 -98
- data/lib/aws-sdk-iotanalytics/client_api.rb +28 -0
- data/lib/aws-sdk-iotanalytics/errors.rb +2 -0
- data/lib/aws-sdk-iotanalytics/resource.rb +2 -0
- data/lib/aws-sdk-iotanalytics/types.rb +662 -316
- metadata +4 -4
@@ -1,3 +1,5 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
1
3
|
# WARNING ABOUT GENERATED CODE
|
2
4
|
#
|
3
5
|
# This file is generated. See the contributing guide for more information:
|
@@ -92,6 +94,7 @@ module Aws::IoTAnalytics
|
|
92
94
|
DeleteDatastoreRequest = Shapes::StructureShape.new(name: 'DeleteDatastoreRequest')
|
93
95
|
DeletePipelineRequest = Shapes::StructureShape.new(name: 'DeletePipelineRequest')
|
94
96
|
DeltaTime = Shapes::StructureShape.new(name: 'DeltaTime')
|
97
|
+
DeltaTimeSessionWindowConfiguration = Shapes::StructureShape.new(name: 'DeltaTimeSessionWindowConfiguration')
|
95
98
|
DescribeChannelRequest = Shapes::StructureShape.new(name: 'DescribeChannelRequest')
|
96
99
|
DescribeChannelResponse = Shapes::StructureShape.new(name: 'DescribeChannelResponse')
|
97
100
|
DescribeDatasetRequest = Shapes::StructureShape.new(name: 'DescribeDatasetRequest')
|
@@ -125,6 +128,10 @@ module Aws::IoTAnalytics
|
|
125
128
|
IotEventsInputName = Shapes::StringShape.new(name: 'IotEventsInputName')
|
126
129
|
LambdaActivity = Shapes::StructureShape.new(name: 'LambdaActivity')
|
127
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')
|
128
135
|
LimitExceededException = Shapes::StructureShape.new(name: 'LimitExceededException')
|
129
136
|
ListChannelsRequest = Shapes::StructureShape.new(name: 'ListChannelsRequest')
|
130
137
|
ListChannelsResponse = Shapes::StructureShape.new(name: 'ListChannelsResponse')
|
@@ -194,6 +201,7 @@ module Aws::IoTAnalytics
|
|
194
201
|
ServiceManagedDatastoreS3Storage = Shapes::StructureShape.new(name: 'ServiceManagedDatastoreS3Storage')
|
195
202
|
ServiceManagedDatastoreS3StorageSummary = Shapes::StructureShape.new(name: 'ServiceManagedDatastoreS3StorageSummary')
|
196
203
|
ServiceUnavailableException = Shapes::StructureShape.new(name: 'ServiceUnavailableException')
|
204
|
+
SessionTimeoutInMinutes = Shapes::IntegerShape.new(name: 'SessionTimeoutInMinutes')
|
197
205
|
SizeInBytes = Shapes::FloatShape.new(name: 'SizeInBytes')
|
198
206
|
SqlQuery = Shapes::StringShape.new(name: 'SqlQuery')
|
199
207
|
SqlQueryDatasetAction = Shapes::StructureShape.new(name: 'SqlQueryDatasetAction')
|
@@ -266,6 +274,7 @@ module Aws::IoTAnalytics
|
|
266
274
|
Channel.add_member(:retention_period, Shapes::ShapeRef.new(shape: RetentionPeriod, location_name: "retentionPeriod"))
|
267
275
|
Channel.add_member(:creation_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "creationTime"))
|
268
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"))
|
269
278
|
Channel.struct_class = Types::Channel
|
270
279
|
|
271
280
|
ChannelActivity.add_member(:name, Shapes::ShapeRef.new(shape: ActivityName, required: true, location_name: "name"))
|
@@ -291,6 +300,7 @@ module Aws::IoTAnalytics
|
|
291
300
|
ChannelSummary.add_member(:status, Shapes::ShapeRef.new(shape: ChannelStatus, location_name: "status"))
|
292
301
|
ChannelSummary.add_member(:creation_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "creationTime"))
|
293
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"))
|
294
304
|
ChannelSummary.struct_class = Types::ChannelSummary
|
295
305
|
|
296
306
|
ContainerDatasetAction.add_member(:image, Shapes::ShapeRef.new(shape: Image, required: true, location_name: "image"))
|
@@ -311,6 +321,7 @@ module Aws::IoTAnalytics
|
|
311
321
|
CreateChannelResponse.struct_class = Types::CreateChannelResponse
|
312
322
|
|
313
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"))
|
314
325
|
CreateDatasetContentRequest.struct_class = Types::CreateDatasetContentRequest
|
315
326
|
|
316
327
|
CreateDatasetContentResponse.add_member(:version_id, Shapes::ShapeRef.new(shape: DatasetContentVersion, location_name: "versionId"))
|
@@ -323,6 +334,7 @@ module Aws::IoTAnalytics
|
|
323
334
|
CreateDatasetRequest.add_member(:retention_period, Shapes::ShapeRef.new(shape: RetentionPeriod, location_name: "retentionPeriod"))
|
324
335
|
CreateDatasetRequest.add_member(:versioning_configuration, Shapes::ShapeRef.new(shape: VersioningConfiguration, location_name: "versioningConfiguration"))
|
325
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"))
|
326
338
|
CreateDatasetRequest.struct_class = Types::CreateDatasetRequest
|
327
339
|
|
328
340
|
CreateDatasetResponse.add_member(:dataset_name, Shapes::ShapeRef.new(shape: DatasetName, location_name: "datasetName"))
|
@@ -380,6 +392,7 @@ module Aws::IoTAnalytics
|
|
380
392
|
Dataset.add_member(:last_update_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "lastUpdateTime"))
|
381
393
|
Dataset.add_member(:retention_period, Shapes::ShapeRef.new(shape: RetentionPeriod, location_name: "retentionPeriod"))
|
382
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"))
|
383
396
|
Dataset.struct_class = Types::Dataset
|
384
397
|
|
385
398
|
DatasetAction.add_member(:action_name, Shapes::ShapeRef.new(shape: DatasetActionName, location_name: "actionName"))
|
@@ -450,6 +463,7 @@ module Aws::IoTAnalytics
|
|
450
463
|
Datastore.add_member(:retention_period, Shapes::ShapeRef.new(shape: RetentionPeriod, location_name: "retentionPeriod"))
|
451
464
|
Datastore.add_member(:creation_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "creationTime"))
|
452
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"))
|
453
467
|
Datastore.struct_class = Types::Datastore
|
454
468
|
|
455
469
|
DatastoreActivity.add_member(:name, Shapes::ShapeRef.new(shape: ActivityName, required: true, location_name: "name"))
|
@@ -474,6 +488,7 @@ module Aws::IoTAnalytics
|
|
474
488
|
DatastoreSummary.add_member(:status, Shapes::ShapeRef.new(shape: DatastoreStatus, location_name: "status"))
|
475
489
|
DatastoreSummary.add_member(:creation_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "creationTime"))
|
476
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"))
|
477
492
|
DatastoreSummary.struct_class = Types::DatastoreSummary
|
478
493
|
|
479
494
|
DeleteChannelRequest.add_member(:channel_name, Shapes::ShapeRef.new(shape: ChannelName, required: true, location: "uri", location_name: "channelName"))
|
@@ -496,6 +511,9 @@ module Aws::IoTAnalytics
|
|
496
511
|
DeltaTime.add_member(:time_expression, Shapes::ShapeRef.new(shape: TimeExpression, required: true, location_name: "timeExpression"))
|
497
512
|
DeltaTime.struct_class = Types::DeltaTime
|
498
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
|
+
|
499
517
|
DescribeChannelRequest.add_member(:channel_name, Shapes::ShapeRef.new(shape: ChannelName, required: true, location: "uri", location_name: "channelName"))
|
500
518
|
DescribeChannelRequest.add_member(:include_statistics, Shapes::ShapeRef.new(shape: IncludeStatisticsFlag, location: "querystring", location_name: "includeStatistics"))
|
501
519
|
DescribeChannelRequest.struct_class = Types::DescribeChannelRequest
|
@@ -581,6 +599,15 @@ module Aws::IoTAnalytics
|
|
581
599
|
LambdaActivity.add_member(:next, Shapes::ShapeRef.new(shape: ActivityName, location_name: "next"))
|
582
600
|
LambdaActivity.struct_class = Types::LambdaActivity
|
583
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
|
+
|
584
611
|
LimitExceededException.add_member(:message, Shapes::ShapeRef.new(shape: errorMessage, location_name: "message"))
|
585
612
|
LimitExceededException.struct_class = Types::LimitExceededException
|
586
613
|
|
@@ -812,6 +839,7 @@ module Aws::IoTAnalytics
|
|
812
839
|
UpdateDatasetRequest.add_member(:content_delivery_rules, Shapes::ShapeRef.new(shape: DatasetContentDeliveryRules, location_name: "contentDeliveryRules"))
|
813
840
|
UpdateDatasetRequest.add_member(:retention_period, Shapes::ShapeRef.new(shape: RetentionPeriod, location_name: "retentionPeriod"))
|
814
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"))
|
815
843
|
UpdateDatasetRequest.struct_class = Types::UpdateDatasetRequest
|
816
844
|
|
817
845
|
UpdateDatastoreRequest.add_member(:datastore_name, Shapes::ShapeRef.new(shape: DatastoreName, required: true, location: "uri", location_name: "datastoreName"))
|
@@ -1,3 +1,5 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
1
3
|
# WARNING ABOUT GENERATED CODE
|
2
4
|
#
|
3
5
|
# This file is generated. See the contributing guide for more information:
|
@@ -23,15 +25,15 @@ module Aws::IoTAnalytics
|
|
23
25
|
# }
|
24
26
|
#
|
25
27
|
# @!attribute [rw] name
|
26
|
-
# The name of the
|
28
|
+
# The name of the addAttributes activity.
|
27
29
|
# @return [String]
|
28
30
|
#
|
29
31
|
# @!attribute [rw] attributes
|
30
|
-
# A list of 1-50
|
32
|
+
# A list of 1-50 `AttributeNameMapping` objects that map an existing
|
31
33
|
# attribute to a new attribute.
|
32
34
|
#
|
33
35
|
# <note markdown="1"> The existing attributes remain in the message, so if you want to
|
34
|
-
# remove the originals, use
|
36
|
+
# remove the originals, use `RemoveAttributeActivity`.
|
35
37
|
#
|
36
38
|
# </note>
|
37
39
|
# @return [Hash<String,String>]
|
@@ -44,14 +46,15 @@ module Aws::IoTAnalytics
|
|
44
46
|
:name,
|
45
47
|
:attributes,
|
46
48
|
:next)
|
49
|
+
SENSITIVE = []
|
47
50
|
include Aws::Structure
|
48
51
|
end
|
49
52
|
|
50
53
|
# Contains informations about errors.
|
51
54
|
#
|
52
55
|
# @!attribute [rw] message_id
|
53
|
-
# The ID of the message that caused the error.
|
54
|
-
# 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.
|
55
58
|
# @return [String]
|
56
59
|
#
|
57
60
|
# @!attribute [rw] error_code
|
@@ -66,6 +69,7 @@ module Aws::IoTAnalytics
|
|
66
69
|
:message_id,
|
67
70
|
:error_code,
|
68
71
|
:error_message)
|
72
|
+
SENSITIVE = []
|
69
73
|
include Aws::Structure
|
70
74
|
end
|
71
75
|
|
@@ -87,13 +91,13 @@ module Aws::IoTAnalytics
|
|
87
91
|
# @return [String]
|
88
92
|
#
|
89
93
|
# @!attribute [rw] messages
|
90
|
-
# The list of messages to be sent. Each message has format:
|
91
|
-
# "messageId": "string", "payload": "string"\\}
|
94
|
+
# The list of messages to be sent. Each message has the format: \\\{
|
95
|
+
# "messageId": "string", "payload": "string"\\}.
|
92
96
|
#
|
93
|
-
#
|
94
|
-
#
|
97
|
+
# The field names of message payloads (data) that you send to AWS IoT
|
98
|
+
# Analytics:
|
95
99
|
#
|
96
|
-
# * Must contain only alphanumeric characters and undescores (\_)
|
100
|
+
# * Must contain only alphanumeric characters and undescores (\_). No
|
97
101
|
# other special characters are allowed.
|
98
102
|
#
|
99
103
|
# * Must begin with an alphabetic character or single underscore (\_).
|
@@ -103,10 +107,10 @@ module Aws::IoTAnalytics
|
|
103
107
|
# * In regular expression terms:
|
104
108
|
# "^\[A-Za-z\_\](\[A-Za-z0-9\]*\|\[A-Za-z0-9\]\[A-Za-z0-9\_\]*)$".
|
105
109
|
#
|
106
|
-
# * Cannot be
|
110
|
+
# * Cannot be more than 255 characters.
|
107
111
|
#
|
108
|
-
# * Are case
|
109
|
-
#
|
112
|
+
# * Are case insensitive. (Fields named foo and FOO in the same
|
113
|
+
# payload are considered duplicates.)
|
110
114
|
#
|
111
115
|
# For example, \\\{"temp\_01": 29\\} or \\\{"\_temp\_01": 29\\}
|
112
116
|
# are valid, but \\\{"temp-01": 29\\}, \\\{"01\_temp": 29\\} or
|
@@ -116,6 +120,7 @@ module Aws::IoTAnalytics
|
|
116
120
|
class BatchPutMessageRequest < Struct.new(
|
117
121
|
:channel_name,
|
118
122
|
:messages)
|
123
|
+
SENSITIVE = []
|
119
124
|
include Aws::Structure
|
120
125
|
end
|
121
126
|
|
@@ -126,6 +131,7 @@ module Aws::IoTAnalytics
|
|
126
131
|
#
|
127
132
|
class BatchPutMessageResponse < Struct.new(
|
128
133
|
:batch_put_message_error_entries)
|
134
|
+
SENSITIVE = []
|
129
135
|
include Aws::Structure
|
130
136
|
end
|
131
137
|
|
@@ -143,12 +149,13 @@ module Aws::IoTAnalytics
|
|
143
149
|
#
|
144
150
|
# @!attribute [rw] reprocessing_id
|
145
151
|
# The ID of the reprocessing task (returned by
|
146
|
-
#
|
152
|
+
# `StartPipelineReprocessing`).
|
147
153
|
# @return [String]
|
148
154
|
#
|
149
155
|
class CancelPipelineReprocessingRequest < Struct.new(
|
150
156
|
:pipeline_name,
|
151
157
|
:reprocessing_id)
|
158
|
+
SENSITIVE = []
|
152
159
|
include Aws::Structure
|
153
160
|
end
|
154
161
|
|
@@ -162,10 +169,10 @@ module Aws::IoTAnalytics
|
|
162
169
|
# @return [String]
|
163
170
|
#
|
164
171
|
# @!attribute [rw] storage
|
165
|
-
# Where channel data is stored. You
|
166
|
-
#
|
167
|
-
#
|
168
|
-
#
|
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.
|
169
176
|
# @return [Types::ChannelStorage]
|
170
177
|
#
|
171
178
|
# @!attribute [rw] arn
|
@@ -188,6 +195,17 @@ module Aws::IoTAnalytics
|
|
188
195
|
# When the channel was last updated.
|
189
196
|
# @return [Time]
|
190
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
|
+
#
|
191
209
|
class Channel < Struct.new(
|
192
210
|
:name,
|
193
211
|
:storage,
|
@@ -195,7 +213,9 @@ module Aws::IoTAnalytics
|
|
195
213
|
:status,
|
196
214
|
:retention_period,
|
197
215
|
:creation_time,
|
198
|
-
:last_update_time
|
216
|
+
:last_update_time,
|
217
|
+
:last_message_arrival_time)
|
218
|
+
SENSITIVE = []
|
199
219
|
include Aws::Structure
|
200
220
|
end
|
201
221
|
|
@@ -212,7 +232,7 @@ module Aws::IoTAnalytics
|
|
212
232
|
# }
|
213
233
|
#
|
214
234
|
# @!attribute [rw] name
|
215
|
-
# The name of the
|
235
|
+
# The name of the channel activity.
|
216
236
|
# @return [String]
|
217
237
|
#
|
218
238
|
# @!attribute [rw] channel_name
|
@@ -227,6 +247,7 @@ module Aws::IoTAnalytics
|
|
227
247
|
:name,
|
228
248
|
:channel_name,
|
229
249
|
:next)
|
250
|
+
SENSITIVE = []
|
230
251
|
include Aws::Structure
|
231
252
|
end
|
232
253
|
|
@@ -238,13 +259,14 @@ module Aws::IoTAnalytics
|
|
238
259
|
#
|
239
260
|
class ChannelStatistics < Struct.new(
|
240
261
|
:size)
|
262
|
+
SENSITIVE = []
|
241
263
|
include Aws::Structure
|
242
264
|
end
|
243
265
|
|
244
|
-
# Where channel data is stored. You may choose one of
|
245
|
-
#
|
246
|
-
#
|
247
|
-
#
|
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.
|
248
270
|
#
|
249
271
|
# @note When making an API call, you may pass ChannelStorage
|
250
272
|
# data as a hash:
|
@@ -260,31 +282,31 @@ module Aws::IoTAnalytics
|
|
260
282
|
# }
|
261
283
|
#
|
262
284
|
# @!attribute [rw] service_managed_s3
|
263
|
-
# Use this to store channel data in an S3 bucket managed by
|
264
|
-
#
|
265
|
-
# customer-managed S3 storage
|
266
|
-
# 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.
|
267
288
|
# @return [Types::ServiceManagedChannelS3Storage]
|
268
289
|
#
|
269
290
|
# @!attribute [rw] customer_managed_s3
|
270
291
|
# Use this to store channel data in an S3 bucket that you manage. If
|
271
|
-
# customer managed storage is selected, the
|
272
|
-
# parameter is ignored.
|
273
|
-
# customer-managed S3 storage
|
274
|
-
#
|
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.
|
275
296
|
# @return [Types::CustomerManagedChannelS3Storage]
|
276
297
|
#
|
277
298
|
class ChannelStorage < Struct.new(
|
278
299
|
:service_managed_s3,
|
279
300
|
:customer_managed_s3)
|
301
|
+
SENSITIVE = []
|
280
302
|
include Aws::Structure
|
281
303
|
end
|
282
304
|
|
283
305
|
# Where channel data is stored.
|
284
306
|
#
|
285
307
|
# @!attribute [rw] service_managed_s3
|
286
|
-
# Used to store channel data in an S3 bucket managed by
|
287
|
-
# Analytics
|
308
|
+
# Used to store channel data in an S3 bucket managed by AWS IoT
|
309
|
+
# Analytics.
|
288
310
|
# @return [Types::ServiceManagedChannelS3StorageSummary]
|
289
311
|
#
|
290
312
|
# @!attribute [rw] customer_managed_s3
|
@@ -294,6 +316,7 @@ module Aws::IoTAnalytics
|
|
294
316
|
class ChannelStorageSummary < Struct.new(
|
295
317
|
:service_managed_s3,
|
296
318
|
:customer_managed_s3)
|
319
|
+
SENSITIVE = []
|
297
320
|
include Aws::Structure
|
298
321
|
end
|
299
322
|
|
@@ -319,16 +342,29 @@ module Aws::IoTAnalytics
|
|
319
342
|
# The last time the channel was updated.
|
320
343
|
# @return [Time]
|
321
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
|
+
#
|
322
356
|
class ChannelSummary < Struct.new(
|
323
357
|
:channel_name,
|
324
358
|
:channel_storage,
|
325
359
|
:status,
|
326
360
|
:creation_time,
|
327
|
-
:last_update_time
|
361
|
+
:last_update_time,
|
362
|
+
:last_message_arrival_time)
|
363
|
+
SENSITIVE = []
|
328
364
|
include Aws::Structure
|
329
365
|
end
|
330
366
|
|
331
|
-
# Information
|
367
|
+
# Information required to run the `containerAction` to produce dataset
|
332
368
|
# contents.
|
333
369
|
#
|
334
370
|
# @note When making an API call, you may pass ContainerDatasetAction
|
@@ -358,28 +394,27 @@ module Aws::IoTAnalytics
|
|
358
394
|
#
|
359
395
|
# @!attribute [rw] image
|
360
396
|
# The ARN of the Docker container stored in your account. The Docker
|
361
|
-
# container contains an application and
|
362
|
-
# is used to generate
|
397
|
+
# container contains an application and required support libraries and
|
398
|
+
# is used to generate dataset contents.
|
363
399
|
# @return [String]
|
364
400
|
#
|
365
401
|
# @!attribute [rw] execution_role_arn
|
366
|
-
# The ARN of the role
|
367
|
-
#
|
368
|
-
#
|
369
|
-
#
|
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.
|
370
406
|
# @return [String]
|
371
407
|
#
|
372
408
|
# @!attribute [rw] resource_configuration
|
373
|
-
# Configuration of the resource
|
374
|
-
# "containerAction".
|
409
|
+
# Configuration of the resource that executes the `containerAction`.
|
375
410
|
# @return [Types::ResourceConfiguration]
|
376
411
|
#
|
377
412
|
# @!attribute [rw] variables
|
378
|
-
# The values of variables used
|
379
|
-
#
|
413
|
+
# The values of variables used in the context of the execution of the
|
414
|
+
# containerized application (basically, parameters passed to the
|
380
415
|
# application). Each variable must have a name and a value given by
|
381
|
-
# one of
|
382
|
-
#
|
416
|
+
# one of `stringValue`, `datasetContentVersionValue`, or
|
417
|
+
# `outputFileUriValue`.
|
383
418
|
# @return [Array<Types::Variable>]
|
384
419
|
#
|
385
420
|
class ContainerDatasetAction < Struct.new(
|
@@ -387,6 +422,7 @@ module Aws::IoTAnalytics
|
|
387
422
|
:execution_role_arn,
|
388
423
|
:resource_configuration,
|
389
424
|
:variables)
|
425
|
+
SENSITIVE = []
|
390
426
|
include Aws::Structure
|
391
427
|
end
|
392
428
|
|
@@ -421,16 +457,15 @@ module Aws::IoTAnalytics
|
|
421
457
|
# @return [String]
|
422
458
|
#
|
423
459
|
# @!attribute [rw] channel_storage
|
424
|
-
# Where channel data is stored. You
|
425
|
-
#
|
426
|
-
#
|
427
|
-
#
|
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.
|
428
464
|
# @return [Types::ChannelStorage]
|
429
465
|
#
|
430
466
|
# @!attribute [rw] retention_period
|
431
467
|
# How long, in days, message data is kept for the channel. When
|
432
|
-
#
|
433
|
-
# ignored.
|
468
|
+
# `customerManagedS3` storage is selected, this parameter is ignored.
|
434
469
|
# @return [Types::RetentionPeriod]
|
435
470
|
#
|
436
471
|
# @!attribute [rw] tags
|
@@ -442,6 +477,7 @@ module Aws::IoTAnalytics
|
|
442
477
|
:channel_storage,
|
443
478
|
:retention_period,
|
444
479
|
:tags)
|
480
|
+
SENSITIVE = []
|
445
481
|
include Aws::Structure
|
446
482
|
end
|
447
483
|
|
@@ -461,6 +497,7 @@ module Aws::IoTAnalytics
|
|
461
497
|
:channel_name,
|
462
498
|
:channel_arn,
|
463
499
|
:retention_period)
|
500
|
+
SENSITIVE = []
|
464
501
|
include Aws::Structure
|
465
502
|
end
|
466
503
|
|
@@ -469,23 +506,36 @@ module Aws::IoTAnalytics
|
|
469
506
|
#
|
470
507
|
# {
|
471
508
|
# dataset_name: "DatasetName", # required
|
509
|
+
# version_id: "DatasetContentVersion",
|
472
510
|
# }
|
473
511
|
#
|
474
512
|
# @!attribute [rw] dataset_name
|
475
|
-
# 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
|
476
523
|
# @return [String]
|
477
524
|
#
|
478
525
|
class CreateDatasetContentRequest < Struct.new(
|
479
|
-
:dataset_name
|
526
|
+
:dataset_name,
|
527
|
+
:version_id)
|
528
|
+
SENSITIVE = []
|
480
529
|
include Aws::Structure
|
481
530
|
end
|
482
531
|
|
483
532
|
# @!attribute [rw] version_id
|
484
|
-
# The version ID of the
|
533
|
+
# The version ID of the dataset contents that are being created.
|
485
534
|
# @return [String]
|
486
535
|
#
|
487
536
|
class CreateDatasetContentResponse < Struct.new(
|
488
537
|
:version_id)
|
538
|
+
SENSITIVE = []
|
489
539
|
include Aws::Structure
|
490
540
|
end
|
491
541
|
|
@@ -575,6 +625,16 @@ module Aws::IoTAnalytics
|
|
575
625
|
# value: "TagValue", # required
|
576
626
|
# },
|
577
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
|
+
# ],
|
578
638
|
# }
|
579
639
|
#
|
580
640
|
# @!attribute [rw] dataset_name
|
@@ -589,36 +649,55 @@ module Aws::IoTAnalytics
|
|
589
649
|
# A list of triggers. A trigger causes data set contents to be
|
590
650
|
# populated at a specified time interval or when another data set's
|
591
651
|
# contents are created. The list of triggers can be empty or contain
|
592
|
-
# up to five
|
652
|
+
# up to five `DataSetTrigger` objects.
|
593
653
|
# @return [Array<Types::DatasetTrigger>]
|
594
654
|
#
|
595
655
|
# @!attribute [rw] content_delivery_rules
|
596
|
-
# When
|
656
|
+
# When dataset contents are created, they are delivered to
|
597
657
|
# destinations specified here.
|
598
658
|
# @return [Array<Types::DatasetContentDeliveryRule>]
|
599
659
|
#
|
600
660
|
# @!attribute [rw] retention_period
|
601
|
-
#
|
602
|
-
#
|
603
|
-
#
|
604
|
-
# versions of
|
605
|
-
# `versioningConfiguration` parameter.
|
606
|
-
#
|
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
|
607
672
|
# @return [Types::RetentionPeriod]
|
608
673
|
#
|
609
674
|
# @!attribute [rw] versioning_configuration
|
610
|
-
#
|
675
|
+
# Optional. How many versions of dataset contents are kept. If not
|
611
676
|
# specified or set to null, only the latest version plus the latest
|
612
677
|
# succeeded version (if they are different) are kept for the time
|
613
|
-
# period specified by the
|
614
|
-
# information, see
|
615
|
-
#
|
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
|
616
685
|
# @return [Types::VersioningConfiguration]
|
617
686
|
#
|
618
687
|
# @!attribute [rw] tags
|
619
688
|
# Metadata which can be used to manage the data set.
|
620
689
|
# @return [Array<Types::Tag>]
|
621
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
|
+
#
|
622
701
|
class CreateDatasetRequest < Struct.new(
|
623
702
|
:dataset_name,
|
624
703
|
:actions,
|
@@ -626,26 +705,29 @@ module Aws::IoTAnalytics
|
|
626
705
|
:content_delivery_rules,
|
627
706
|
:retention_period,
|
628
707
|
:versioning_configuration,
|
629
|
-
:tags
|
708
|
+
:tags,
|
709
|
+
:late_data_rules)
|
710
|
+
SENSITIVE = []
|
630
711
|
include Aws::Structure
|
631
712
|
end
|
632
713
|
|
633
714
|
# @!attribute [rw] dataset_name
|
634
|
-
# The name of the
|
715
|
+
# The name of the dataset.
|
635
716
|
# @return [String]
|
636
717
|
#
|
637
718
|
# @!attribute [rw] dataset_arn
|
638
|
-
# The ARN of the
|
719
|
+
# The ARN of the dataset.
|
639
720
|
# @return [String]
|
640
721
|
#
|
641
722
|
# @!attribute [rw] retention_period
|
642
|
-
# How long, in days,
|
723
|
+
# How long, in days, dataset contents are kept for the dataset.
|
643
724
|
# @return [Types::RetentionPeriod]
|
644
725
|
#
|
645
726
|
class CreateDatasetResponse < Struct.new(
|
646
727
|
:dataset_name,
|
647
728
|
:dataset_arn,
|
648
729
|
:retention_period)
|
730
|
+
SENSITIVE = []
|
649
731
|
include Aws::Structure
|
650
732
|
end
|
651
733
|
|
@@ -680,16 +762,15 @@ module Aws::IoTAnalytics
|
|
680
762
|
# @return [String]
|
681
763
|
#
|
682
764
|
# @!attribute [rw] datastore_storage
|
683
|
-
# Where data store data is stored. You
|
684
|
-
#
|
685
|
-
#
|
686
|
-
#
|
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.
|
687
769
|
# @return [Types::DatastoreStorage]
|
688
770
|
#
|
689
771
|
# @!attribute [rw] retention_period
|
690
772
|
# How long, in days, message data is kept for the data store. When
|
691
|
-
#
|
692
|
-
# ignored.
|
773
|
+
# `customerManagedS3` storage is selected, this parameter is ignored.
|
693
774
|
# @return [Types::RetentionPeriod]
|
694
775
|
#
|
695
776
|
# @!attribute [rw] tags
|
@@ -701,6 +782,7 @@ module Aws::IoTAnalytics
|
|
701
782
|
:datastore_storage,
|
702
783
|
:retention_period,
|
703
784
|
:tags)
|
785
|
+
SENSITIVE = []
|
704
786
|
include Aws::Structure
|
705
787
|
end
|
706
788
|
|
@@ -720,6 +802,7 @@ module Aws::IoTAnalytics
|
|
720
802
|
:datastore_name,
|
721
803
|
:datastore_arn,
|
722
804
|
:retention_period)
|
805
|
+
SENSITIVE = []
|
723
806
|
include Aws::Structure
|
724
807
|
end
|
725
808
|
|
@@ -802,16 +885,16 @@ module Aws::IoTAnalytics
|
|
802
885
|
# @return [String]
|
803
886
|
#
|
804
887
|
# @!attribute [rw] pipeline_activities
|
805
|
-
# A list of
|
888
|
+
# A list of `PipelineActivity` objects. Activities perform
|
806
889
|
# transformations on your messages, such as removing, renaming or
|
807
890
|
# adding message attributes; filtering messages based on attribute
|
808
891
|
# values; invoking your Lambda functions on messages for advanced
|
809
892
|
# processing; or performing mathematical transformations to normalize
|
810
893
|
# device data.
|
811
894
|
#
|
812
|
-
# The list can be 2-25
|
895
|
+
# The list can be 2-25 `PipelineActivity` objects and must contain
|
813
896
|
# both a `channel` and a `datastore` activity. Each entry in the list
|
814
|
-
# must contain only one activity
|
897
|
+
# must contain only one activity. For example:
|
815
898
|
#
|
816
899
|
# `pipelineActivities = [ \{ "channel": \{ ... \} \}, \{ "lambda": \{
|
817
900
|
# ... \} \}, ... ]`
|
@@ -825,6 +908,7 @@ module Aws::IoTAnalytics
|
|
825
908
|
:pipeline_name,
|
826
909
|
:pipeline_activities,
|
827
910
|
:tags)
|
911
|
+
SENSITIVE = []
|
828
912
|
include Aws::Structure
|
829
913
|
end
|
830
914
|
|
@@ -839,14 +923,14 @@ module Aws::IoTAnalytics
|
|
839
923
|
class CreatePipelineResponse < Struct.new(
|
840
924
|
:pipeline_name,
|
841
925
|
:pipeline_arn)
|
926
|
+
SENSITIVE = []
|
842
927
|
include Aws::Structure
|
843
928
|
end
|
844
929
|
|
845
930
|
# Use this to store channel data in an S3 bucket that you manage. If
|
846
|
-
# customer managed storage is selected, the
|
847
|
-
#
|
848
|
-
# customer-managed S3 storage
|
849
|
-
# 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.
|
850
934
|
#
|
851
935
|
# @note When making an API call, you may pass CustomerManagedChannelS3Storage
|
852
936
|
# data as a hash:
|
@@ -858,18 +942,18 @@ module Aws::IoTAnalytics
|
|
858
942
|
# }
|
859
943
|
#
|
860
944
|
# @!attribute [rw] bucket
|
861
|
-
# The name of the
|
945
|
+
# The name of the S3 bucket in which channel data is stored.
|
862
946
|
# @return [String]
|
863
947
|
#
|
864
948
|
# @!attribute [rw] key_prefix
|
865
|
-
#
|
866
|
-
# objects. Each object in an
|
867
|
-
#
|
868
|
-
#
|
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 (/).
|
869
953
|
# @return [String]
|
870
954
|
#
|
871
955
|
# @!attribute [rw] role_arn
|
872
|
-
# The ARN of the role
|
956
|
+
# The ARN of the role that grants AWS IoT Analytics permission to
|
873
957
|
# interact with your Amazon S3 resources.
|
874
958
|
# @return [String]
|
875
959
|
#
|
@@ -877,24 +961,25 @@ module Aws::IoTAnalytics
|
|
877
961
|
:bucket,
|
878
962
|
:key_prefix,
|
879
963
|
:role_arn)
|
964
|
+
SENSITIVE = []
|
880
965
|
include Aws::Structure
|
881
966
|
end
|
882
967
|
|
883
968
|
# Used to store channel data in an S3 bucket that you manage.
|
884
969
|
#
|
885
970
|
# @!attribute [rw] bucket
|
886
|
-
# The name of the
|
971
|
+
# The name of the S3 bucket in which channel data is stored.
|
887
972
|
# @return [String]
|
888
973
|
#
|
889
974
|
# @!attribute [rw] key_prefix
|
890
|
-
#
|
891
|
-
# objects. Each object in an
|
892
|
-
#
|
893
|
-
#
|
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 (/).
|
894
979
|
# @return [String]
|
895
980
|
#
|
896
981
|
# @!attribute [rw] role_arn
|
897
|
-
# The ARN of the role
|
982
|
+
# The ARN of the role that grants AWS IoT Analytics permission to
|
898
983
|
# interact with your Amazon S3 resources.
|
899
984
|
# @return [String]
|
900
985
|
#
|
@@ -902,14 +987,14 @@ module Aws::IoTAnalytics
|
|
902
987
|
:bucket,
|
903
988
|
:key_prefix,
|
904
989
|
:role_arn)
|
990
|
+
SENSITIVE = []
|
905
991
|
include Aws::Structure
|
906
992
|
end
|
907
993
|
|
908
994
|
# Use this to store data store data in an S3 bucket that you manage.
|
909
|
-
# When customer
|
910
|
-
# parameter is ignored.
|
911
|
-
# customer-managed S3 storage
|
912
|
-
# 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.
|
913
998
|
#
|
914
999
|
# @note When making an API call, you may pass CustomerManagedDatastoreS3Storage
|
915
1000
|
# data as a hash:
|
@@ -921,18 +1006,18 @@ module Aws::IoTAnalytics
|
|
921
1006
|
# }
|
922
1007
|
#
|
923
1008
|
# @!attribute [rw] bucket
|
924
|
-
# The name of the
|
1009
|
+
# The name of the S3 bucket in which data store data is stored.
|
925
1010
|
# @return [String]
|
926
1011
|
#
|
927
1012
|
# @!attribute [rw] key_prefix
|
928
|
-
#
|
929
|
-
#
|
930
|
-
#
|
931
|
-
#
|
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 (/).
|
932
1017
|
# @return [String]
|
933
1018
|
#
|
934
1019
|
# @!attribute [rw] role_arn
|
935
|
-
# The ARN of the role
|
1020
|
+
# The ARN of the role that grants AWS IoT Analytics permission to
|
936
1021
|
# interact with your Amazon S3 resources.
|
937
1022
|
# @return [String]
|
938
1023
|
#
|
@@ -940,24 +1025,25 @@ module Aws::IoTAnalytics
|
|
940
1025
|
:bucket,
|
941
1026
|
:key_prefix,
|
942
1027
|
:role_arn)
|
1028
|
+
SENSITIVE = []
|
943
1029
|
include Aws::Structure
|
944
1030
|
end
|
945
1031
|
|
946
1032
|
# Used to store data store data in an S3 bucket that you manage.
|
947
1033
|
#
|
948
1034
|
# @!attribute [rw] bucket
|
949
|
-
# The name of the
|
1035
|
+
# The name of the S3 bucket in which data store data is stored.
|
950
1036
|
# @return [String]
|
951
1037
|
#
|
952
1038
|
# @!attribute [rw] key_prefix
|
953
|
-
#
|
954
|
-
#
|
955
|
-
#
|
956
|
-
#
|
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 (/).
|
957
1043
|
# @return [String]
|
958
1044
|
#
|
959
1045
|
# @!attribute [rw] role_arn
|
960
|
-
# The ARN of the role
|
1046
|
+
# The ARN of the role that grants AWS IoT Analytics permission to
|
961
1047
|
# interact with your Amazon S3 resources.
|
962
1048
|
# @return [String]
|
963
1049
|
#
|
@@ -965,6 +1051,7 @@ module Aws::IoTAnalytics
|
|
965
1051
|
:bucket,
|
966
1052
|
:key_prefix,
|
967
1053
|
:role_arn)
|
1054
|
+
SENSITIVE = []
|
968
1055
|
include Aws::Structure
|
969
1056
|
end
|
970
1057
|
|
@@ -979,18 +1066,18 @@ module Aws::IoTAnalytics
|
|
979
1066
|
# @return [String]
|
980
1067
|
#
|
981
1068
|
# @!attribute [rw] actions
|
982
|
-
# The
|
1069
|
+
# The `DatasetAction` objects that automatically create the data set
|
983
1070
|
# contents.
|
984
1071
|
# @return [Array<Types::DatasetAction>]
|
985
1072
|
#
|
986
1073
|
# @!attribute [rw] triggers
|
987
|
-
# The
|
1074
|
+
# The `DatasetTrigger` objects that specify when the data set is
|
988
1075
|
# automatically updated.
|
989
1076
|
# @return [Array<Types::DatasetTrigger>]
|
990
1077
|
#
|
991
1078
|
# @!attribute [rw] content_delivery_rules
|
992
|
-
# When
|
993
|
-
#
|
1079
|
+
# When dataset contents are created they are delivered to destinations
|
1080
|
+
# specified here.
|
994
1081
|
# @return [Array<Types::DatasetContentDeliveryRule>]
|
995
1082
|
#
|
996
1083
|
# @!attribute [rw] status
|
@@ -1006,19 +1093,32 @@ module Aws::IoTAnalytics
|
|
1006
1093
|
# @return [Time]
|
1007
1094
|
#
|
1008
1095
|
# @!attribute [rw] retention_period
|
1009
|
-
#
|
1010
|
-
# set.
|
1096
|
+
# Optional. How long, in days, message data is kept for the data set.
|
1011
1097
|
# @return [Types::RetentionPeriod]
|
1012
1098
|
#
|
1013
1099
|
# @!attribute [rw] versioning_configuration
|
1014
|
-
#
|
1100
|
+
# Optional. How many versions of dataset contents are kept. If not
|
1015
1101
|
# specified or set to null, only the latest version plus the latest
|
1016
1102
|
# succeeded version (if they are different) are kept for the time
|
1017
|
-
# period specified by the
|
1018
|
-
# information, see
|
1019
|
-
#
|
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
|
1020
1110
|
# @return [Types::VersioningConfiguration]
|
1021
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
|
+
#
|
1022
1122
|
class Dataset < Struct.new(
|
1023
1123
|
:name,
|
1024
1124
|
:arn,
|
@@ -1029,11 +1129,13 @@ module Aws::IoTAnalytics
|
|
1029
1129
|
:creation_time,
|
1030
1130
|
:last_update_time,
|
1031
1131
|
:retention_period,
|
1032
|
-
:versioning_configuration
|
1132
|
+
:versioning_configuration,
|
1133
|
+
:late_data_rules)
|
1134
|
+
SENSITIVE = []
|
1033
1135
|
include Aws::Structure
|
1034
1136
|
end
|
1035
1137
|
|
1036
|
-
# A
|
1138
|
+
# A `DatasetAction` object that specifies how data set contents are
|
1037
1139
|
# automatically created.
|
1038
1140
|
#
|
1039
1141
|
# @note When making an API call, you may pass DatasetAction
|
@@ -1081,44 +1183,45 @@ module Aws::IoTAnalytics
|
|
1081
1183
|
# @return [String]
|
1082
1184
|
#
|
1083
1185
|
# @!attribute [rw] query_action
|
1084
|
-
# An
|
1186
|
+
# An `SqlQueryDatasetAction` object that uses an SQL query to
|
1085
1187
|
# automatically create data set contents.
|
1086
1188
|
# @return [Types::SqlQueryDatasetAction]
|
1087
1189
|
#
|
1088
1190
|
# @!attribute [rw] container_action
|
1089
|
-
# Information
|
1090
|
-
# application
|
1091
|
-
#
|
1092
|
-
# 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.
|
1093
1194
|
# @return [Types::ContainerDatasetAction]
|
1094
1195
|
#
|
1095
1196
|
class DatasetAction < Struct.new(
|
1096
1197
|
:action_name,
|
1097
1198
|
:query_action,
|
1098
1199
|
:container_action)
|
1200
|
+
SENSITIVE = []
|
1099
1201
|
include Aws::Structure
|
1100
1202
|
end
|
1101
1203
|
|
1102
|
-
# Information about the action
|
1103
|
-
#
|
1204
|
+
# Information about the action that automatically creates the dataset's
|
1205
|
+
# contents.
|
1104
1206
|
#
|
1105
1207
|
# @!attribute [rw] action_name
|
1106
|
-
# The name of the action
|
1208
|
+
# The name of the action that automatically creates the dataset's
|
1107
1209
|
# contents.
|
1108
1210
|
# @return [String]
|
1109
1211
|
#
|
1110
1212
|
# @!attribute [rw] action_type
|
1111
|
-
# The type of action by which the
|
1213
|
+
# The type of action by which the dataset's contents are
|
1112
1214
|
# automatically created.
|
1113
1215
|
# @return [String]
|
1114
1216
|
#
|
1115
1217
|
class DatasetActionSummary < Struct.new(
|
1116
1218
|
:action_name,
|
1117
1219
|
:action_type)
|
1220
|
+
SENSITIVE = []
|
1118
1221
|
include Aws::Structure
|
1119
1222
|
end
|
1120
1223
|
|
1121
|
-
# The destination to which
|
1224
|
+
# The destination to which dataset contents are delivered.
|
1122
1225
|
#
|
1123
1226
|
# @note When making an API call, you may pass DatasetContentDeliveryDestination
|
1124
1227
|
# data as a hash:
|
@@ -1140,22 +1243,23 @@ module Aws::IoTAnalytics
|
|
1140
1243
|
# }
|
1141
1244
|
#
|
1142
1245
|
# @!attribute [rw] iot_events_destination_configuration
|
1143
|
-
# Configuration information for delivery of
|
1246
|
+
# Configuration information for delivery of dataset contents to AWS
|
1144
1247
|
# IoT Events.
|
1145
1248
|
# @return [Types::IotEventsDestinationConfiguration]
|
1146
1249
|
#
|
1147
1250
|
# @!attribute [rw] s3_destination_configuration
|
1148
|
-
# Configuration information for delivery of
|
1149
|
-
#
|
1251
|
+
# Configuration information for delivery of dataset contents to Amazon
|
1252
|
+
# S3.
|
1150
1253
|
# @return [Types::S3DestinationConfiguration]
|
1151
1254
|
#
|
1152
1255
|
class DatasetContentDeliveryDestination < Struct.new(
|
1153
1256
|
:iot_events_destination_configuration,
|
1154
1257
|
:s3_destination_configuration)
|
1258
|
+
SENSITIVE = []
|
1155
1259
|
include Aws::Structure
|
1156
1260
|
end
|
1157
1261
|
|
1158
|
-
# When
|
1262
|
+
# When dataset contents are created, they are delivered to destination
|
1159
1263
|
# specified here.
|
1160
1264
|
#
|
1161
1265
|
# @note When making an API call, you may pass DatasetContentDeliveryRule
|
@@ -1181,16 +1285,17 @@ module Aws::IoTAnalytics
|
|
1181
1285
|
# }
|
1182
1286
|
#
|
1183
1287
|
# @!attribute [rw] entry_name
|
1184
|
-
# The name of the
|
1288
|
+
# The name of the dataset content delivery rules entry.
|
1185
1289
|
# @return [String]
|
1186
1290
|
#
|
1187
1291
|
# @!attribute [rw] destination
|
1188
|
-
# The destination to which
|
1292
|
+
# The destination to which dataset contents are delivered.
|
1189
1293
|
# @return [Types::DatasetContentDeliveryDestination]
|
1190
1294
|
#
|
1191
1295
|
class DatasetContentDeliveryRule < Struct.new(
|
1192
1296
|
:entry_name,
|
1193
1297
|
:destination)
|
1298
|
+
SENSITIVE = []
|
1194
1299
|
include Aws::Structure
|
1195
1300
|
end
|
1196
1301
|
|
@@ -1198,8 +1303,8 @@ module Aws::IoTAnalytics
|
|
1198
1303
|
# state.
|
1199
1304
|
#
|
1200
1305
|
# @!attribute [rw] state
|
1201
|
-
# The state of the data set contents. Can be one of
|
1202
|
-
#
|
1306
|
+
# The state of the data set contents. Can be one of READY, CREATING,
|
1307
|
+
# SUCCEEDED, or FAILED.
|
1203
1308
|
# @return [String]
|
1204
1309
|
#
|
1205
1310
|
# @!attribute [rw] reason
|
@@ -1209,13 +1314,14 @@ module Aws::IoTAnalytics
|
|
1209
1314
|
class DatasetContentStatus < Struct.new(
|
1210
1315
|
:state,
|
1211
1316
|
:reason)
|
1317
|
+
SENSITIVE = []
|
1212
1318
|
include Aws::Structure
|
1213
1319
|
end
|
1214
1320
|
|
1215
|
-
# Summary information about
|
1321
|
+
# Summary information about dataset contents.
|
1216
1322
|
#
|
1217
1323
|
# @!attribute [rw] version
|
1218
|
-
# The version of the
|
1324
|
+
# The version of the dataset contents.
|
1219
1325
|
# @return [String]
|
1220
1326
|
#
|
1221
1327
|
# @!attribute [rw] status
|
@@ -1223,11 +1329,11 @@ module Aws::IoTAnalytics
|
|
1223
1329
|
# @return [Types::DatasetContentStatus]
|
1224
1330
|
#
|
1225
1331
|
# @!attribute [rw] creation_time
|
1226
|
-
# The actual time the creation of the
|
1332
|
+
# The actual time the creation of the dataset contents was started.
|
1227
1333
|
# @return [Time]
|
1228
1334
|
#
|
1229
1335
|
# @!attribute [rw] schedule_time
|
1230
|
-
# The time the creation of the
|
1336
|
+
# The time the creation of the dataset contents was scheduled to
|
1231
1337
|
# start.
|
1232
1338
|
# @return [Time]
|
1233
1339
|
#
|
@@ -1242,11 +1348,12 @@ module Aws::IoTAnalytics
|
|
1242
1348
|
:creation_time,
|
1243
1349
|
:schedule_time,
|
1244
1350
|
:completion_time)
|
1351
|
+
SENSITIVE = []
|
1245
1352
|
include Aws::Structure
|
1246
1353
|
end
|
1247
1354
|
|
1248
|
-
# The
|
1249
|
-
#
|
1355
|
+
# The dataset whose latest contents are used as input to the notebook or
|
1356
|
+
# application.
|
1250
1357
|
#
|
1251
1358
|
# @note When making an API call, you may pass DatasetContentVersionValue
|
1252
1359
|
# data as a hash:
|
@@ -1256,12 +1363,13 @@ module Aws::IoTAnalytics
|
|
1256
1363
|
# }
|
1257
1364
|
#
|
1258
1365
|
# @!attribute [rw] dataset_name
|
1259
|
-
# The name of the
|
1366
|
+
# The name of the dataset whose latest contents are used as input to
|
1260
1367
|
# the notebook or application.
|
1261
1368
|
# @return [String]
|
1262
1369
|
#
|
1263
1370
|
class DatasetContentVersionValue < Struct.new(
|
1264
1371
|
:dataset_name)
|
1372
|
+
SENSITIVE = []
|
1265
1373
|
include Aws::Structure
|
1266
1374
|
end
|
1267
1375
|
|
@@ -1272,12 +1380,13 @@ module Aws::IoTAnalytics
|
|
1272
1380
|
# @return [String]
|
1273
1381
|
#
|
1274
1382
|
# @!attribute [rw] data_uri
|
1275
|
-
# The
|
1383
|
+
# The presigned URI of the data set item.
|
1276
1384
|
# @return [String]
|
1277
1385
|
#
|
1278
1386
|
class DatasetEntry < Struct.new(
|
1279
1387
|
:entry_name,
|
1280
1388
|
:data_uri)
|
1389
|
+
SENSITIVE = []
|
1281
1390
|
include Aws::Structure
|
1282
1391
|
end
|
1283
1392
|
|
@@ -1303,11 +1412,11 @@ module Aws::IoTAnalytics
|
|
1303
1412
|
# A list of triggers. A trigger causes data set content to be
|
1304
1413
|
# populated at a specified time interval or when another data set is
|
1305
1414
|
# populated. The list of triggers can be empty or contain up to five
|
1306
|
-
# DataSetTrigger objects
|
1415
|
+
# `DataSetTrigger` objects
|
1307
1416
|
# @return [Array<Types::DatasetTrigger>]
|
1308
1417
|
#
|
1309
1418
|
# @!attribute [rw] actions
|
1310
|
-
# A list of
|
1419
|
+
# A list of `DataActionSummary` objects.
|
1311
1420
|
# @return [Array<Types::DatasetActionSummary>]
|
1312
1421
|
#
|
1313
1422
|
class DatasetSummary < Struct.new(
|
@@ -1317,11 +1426,12 @@ module Aws::IoTAnalytics
|
|
1317
1426
|
:last_update_time,
|
1318
1427
|
:triggers,
|
1319
1428
|
:actions)
|
1429
|
+
SENSITIVE = []
|
1320
1430
|
include Aws::Structure
|
1321
1431
|
end
|
1322
1432
|
|
1323
|
-
# The
|
1324
|
-
#
|
1433
|
+
# The `DatasetTrigger` that specifies when the data set is automatically
|
1434
|
+
# updated.
|
1325
1435
|
#
|
1326
1436
|
# @note When making an API call, you may pass DatasetTrigger
|
1327
1437
|
# data as a hash:
|
@@ -1336,7 +1446,7 @@ module Aws::IoTAnalytics
|
|
1336
1446
|
# }
|
1337
1447
|
#
|
1338
1448
|
# @!attribute [rw] schedule
|
1339
|
-
# The
|
1449
|
+
# The Schedule when the trigger is initiated.
|
1340
1450
|
# @return [Types::Schedule]
|
1341
1451
|
#
|
1342
1452
|
# @!attribute [rw] dataset
|
@@ -1347,6 +1457,7 @@ module Aws::IoTAnalytics
|
|
1347
1457
|
class DatasetTrigger < Struct.new(
|
1348
1458
|
:schedule,
|
1349
1459
|
:dataset)
|
1460
|
+
SENSITIVE = []
|
1350
1461
|
include Aws::Structure
|
1351
1462
|
end
|
1352
1463
|
|
@@ -1357,10 +1468,10 @@ module Aws::IoTAnalytics
|
|
1357
1468
|
# @return [String]
|
1358
1469
|
#
|
1359
1470
|
# @!attribute [rw] storage
|
1360
|
-
# Where data store data is stored. You
|
1361
|
-
#
|
1362
|
-
#
|
1363
|
-
#
|
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.
|
1364
1475
|
# @return [Types::DatastoreStorage]
|
1365
1476
|
#
|
1366
1477
|
# @!attribute [rw] arn
|
@@ -1385,8 +1496,7 @@ module Aws::IoTAnalytics
|
|
1385
1496
|
#
|
1386
1497
|
# @!attribute [rw] retention_period
|
1387
1498
|
# How long, in days, message data is kept for the data store. When
|
1388
|
-
#
|
1389
|
-
# ignored.
|
1499
|
+
# `customerManagedS3` storage is selected, this parameter is ignored.
|
1390
1500
|
# @return [Types::RetentionPeriod]
|
1391
1501
|
#
|
1392
1502
|
# @!attribute [rw] creation_time
|
@@ -1397,6 +1507,17 @@ module Aws::IoTAnalytics
|
|
1397
1507
|
# The last time the data store was updated.
|
1398
1508
|
# @return [Time]
|
1399
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
|
+
#
|
1400
1521
|
class Datastore < Struct.new(
|
1401
1522
|
:name,
|
1402
1523
|
:storage,
|
@@ -1404,11 +1525,13 @@ module Aws::IoTAnalytics
|
|
1404
1525
|
:status,
|
1405
1526
|
:retention_period,
|
1406
1527
|
:creation_time,
|
1407
|
-
:last_update_time
|
1528
|
+
:last_update_time,
|
1529
|
+
:last_message_arrival_time)
|
1530
|
+
SENSITIVE = []
|
1408
1531
|
include Aws::Structure
|
1409
1532
|
end
|
1410
1533
|
|
1411
|
-
# The
|
1534
|
+
# The datastore activity that specifies where to store the processed
|
1412
1535
|
# data.
|
1413
1536
|
#
|
1414
1537
|
# @note When making an API call, you may pass DatastoreActivity
|
@@ -1420,7 +1543,7 @@ module Aws::IoTAnalytics
|
|
1420
1543
|
# }
|
1421
1544
|
#
|
1422
1545
|
# @!attribute [rw] name
|
1423
|
-
# The name of the
|
1546
|
+
# The name of the datastore activity.
|
1424
1547
|
# @return [String]
|
1425
1548
|
#
|
1426
1549
|
# @!attribute [rw] datastore_name
|
@@ -1430,6 +1553,7 @@ module Aws::IoTAnalytics
|
|
1430
1553
|
class DatastoreActivity < Struct.new(
|
1431
1554
|
:name,
|
1432
1555
|
:datastore_name)
|
1556
|
+
SENSITIVE = []
|
1433
1557
|
include Aws::Structure
|
1434
1558
|
end
|
1435
1559
|
|
@@ -1441,13 +1565,14 @@ module Aws::IoTAnalytics
|
|
1441
1565
|
#
|
1442
1566
|
class DatastoreStatistics < Struct.new(
|
1443
1567
|
:size)
|
1568
|
+
SENSITIVE = []
|
1444
1569
|
include Aws::Structure
|
1445
1570
|
end
|
1446
1571
|
|
1447
|
-
# Where data store data is stored. You
|
1448
|
-
#
|
1449
|
-
#
|
1450
|
-
# 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.
|
1451
1576
|
#
|
1452
1577
|
# @note When making an API call, you may pass DatastoreStorage
|
1453
1578
|
# data as a hash:
|
@@ -1463,15 +1588,14 @@ module Aws::IoTAnalytics
|
|
1463
1588
|
# }
|
1464
1589
|
#
|
1465
1590
|
# @!attribute [rw] service_managed_s3
|
1466
|
-
# Use this to store data store data in an S3 bucket managed by
|
1467
|
-
#
|
1468
|
-
# customer-managed S3 storage
|
1469
|
-
# 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.
|
1470
1594
|
# @return [Types::ServiceManagedDatastoreS3Storage]
|
1471
1595
|
#
|
1472
1596
|
# @!attribute [rw] customer_managed_s3
|
1473
1597
|
# Use this to store data store data in an S3 bucket that you manage.
|
1474
|
-
# When customer managed storage is selected, the
|
1598
|
+
# When customer managed storage is selected, the `retentionPeriod`
|
1475
1599
|
# parameter is ignored. The choice of service-managed or
|
1476
1600
|
# customer-managed S3 storage cannot be changed after creation of the
|
1477
1601
|
# data store.
|
@@ -1480,14 +1604,15 @@ module Aws::IoTAnalytics
|
|
1480
1604
|
class DatastoreStorage < Struct.new(
|
1481
1605
|
:service_managed_s3,
|
1482
1606
|
:customer_managed_s3)
|
1607
|
+
SENSITIVE = []
|
1483
1608
|
include Aws::Structure
|
1484
1609
|
end
|
1485
1610
|
|
1486
1611
|
# Where data store data is stored.
|
1487
1612
|
#
|
1488
1613
|
# @!attribute [rw] service_managed_s3
|
1489
|
-
# Used to store data store data in an S3 bucket managed by
|
1490
|
-
# Analytics
|
1614
|
+
# Used to store data store data in an S3 bucket managed by AWS IoT
|
1615
|
+
# Analytics.
|
1491
1616
|
# @return [Types::ServiceManagedDatastoreS3StorageSummary]
|
1492
1617
|
#
|
1493
1618
|
# @!attribute [rw] customer_managed_s3
|
@@ -1497,6 +1622,7 @@ module Aws::IoTAnalytics
|
|
1497
1622
|
class DatastoreStorageSummary < Struct.new(
|
1498
1623
|
:service_managed_s3,
|
1499
1624
|
:customer_managed_s3)
|
1625
|
+
SENSITIVE = []
|
1500
1626
|
include Aws::Structure
|
1501
1627
|
end
|
1502
1628
|
|
@@ -1522,12 +1648,25 @@ module Aws::IoTAnalytics
|
|
1522
1648
|
# The last time the data store was updated.
|
1523
1649
|
# @return [Time]
|
1524
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
|
+
#
|
1525
1662
|
class DatastoreSummary < Struct.new(
|
1526
1663
|
:datastore_name,
|
1527
1664
|
:datastore_storage,
|
1528
1665
|
:status,
|
1529
1666
|
:creation_time,
|
1530
|
-
:last_update_time
|
1667
|
+
:last_update_time,
|
1668
|
+
:last_message_arrival_time)
|
1669
|
+
SENSITIVE = []
|
1531
1670
|
include Aws::Structure
|
1532
1671
|
end
|
1533
1672
|
|
@@ -1544,6 +1683,7 @@ module Aws::IoTAnalytics
|
|
1544
1683
|
#
|
1545
1684
|
class DeleteChannelRequest < Struct.new(
|
1546
1685
|
:channel_name)
|
1686
|
+
SENSITIVE = []
|
1547
1687
|
include Aws::Structure
|
1548
1688
|
end
|
1549
1689
|
|
@@ -1556,11 +1696,11 @@ module Aws::IoTAnalytics
|
|
1556
1696
|
# }
|
1557
1697
|
#
|
1558
1698
|
# @!attribute [rw] dataset_name
|
1559
|
-
# The name of the
|
1699
|
+
# The name of the dataset whose content is deleted.
|
1560
1700
|
# @return [String]
|
1561
1701
|
#
|
1562
1702
|
# @!attribute [rw] version_id
|
1563
|
-
# The version of the
|
1703
|
+
# The version of the dataset whose content is deleted. You can also
|
1564
1704
|
# use the strings "$LATEST" or "$LATEST\_SUCCEEDED" to delete the
|
1565
1705
|
# latest or latest successfully completed data set. If not specified,
|
1566
1706
|
# "$LATEST\_SUCCEEDED" is the default.
|
@@ -1569,6 +1709,7 @@ module Aws::IoTAnalytics
|
|
1569
1709
|
class DeleteDatasetContentRequest < Struct.new(
|
1570
1710
|
:dataset_name,
|
1571
1711
|
:version_id)
|
1712
|
+
SENSITIVE = []
|
1572
1713
|
include Aws::Structure
|
1573
1714
|
end
|
1574
1715
|
|
@@ -1585,6 +1726,7 @@ module Aws::IoTAnalytics
|
|
1585
1726
|
#
|
1586
1727
|
class DeleteDatasetRequest < Struct.new(
|
1587
1728
|
:dataset_name)
|
1729
|
+
SENSITIVE = []
|
1588
1730
|
include Aws::Structure
|
1589
1731
|
end
|
1590
1732
|
|
@@ -1601,6 +1743,7 @@ module Aws::IoTAnalytics
|
|
1601
1743
|
#
|
1602
1744
|
class DeleteDatastoreRequest < Struct.new(
|
1603
1745
|
:datastore_name)
|
1746
|
+
SENSITIVE = []
|
1604
1747
|
include Aws::Structure
|
1605
1748
|
end
|
1606
1749
|
|
@@ -1617,6 +1760,7 @@ module Aws::IoTAnalytics
|
|
1617
1760
|
#
|
1618
1761
|
class DeletePipelineRequest < Struct.new(
|
1619
1762
|
:pipeline_name)
|
1763
|
+
SENSITIVE = []
|
1620
1764
|
include Aws::Structure
|
1621
1765
|
end
|
1622
1766
|
|
@@ -1632,28 +1776,70 @@ module Aws::IoTAnalytics
|
|
1632
1776
|
# }
|
1633
1777
|
#
|
1634
1778
|
# @!attribute [rw] offset_seconds
|
1635
|
-
# The number of seconds of estimated
|
1636
|
-
# data. When you create
|
1637
|
-
# specified
|
1638
|
-
#
|
1639
|
-
#
|
1640
|
-
#
|
1641
|
-
#
|
1642
|
-
#
|
1643
|
-
#
|
1644
|
-
# 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.
|
1645
1788
|
# @return [Integer]
|
1646
1789
|
#
|
1647
1790
|
# @!attribute [rw] time_expression
|
1648
|
-
# An expression by which the time of the message data
|
1649
|
-
# determined. This
|
1650
|
-
# 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
|
1651
1794
|
# generated.
|
1652
1795
|
# @return [String]
|
1653
1796
|
#
|
1654
1797
|
class DeltaTime < Struct.new(
|
1655
1798
|
:offset_seconds,
|
1656
1799
|
:time_expression)
|
1800
|
+
SENSITIVE = []
|
1801
|
+
include Aws::Structure
|
1802
|
+
end
|
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 = []
|
1657
1843
|
include Aws::Structure
|
1658
1844
|
end
|
1659
1845
|
|
@@ -1678,6 +1864,7 @@ module Aws::IoTAnalytics
|
|
1678
1864
|
class DescribeChannelRequest < Struct.new(
|
1679
1865
|
:channel_name,
|
1680
1866
|
:include_statistics)
|
1867
|
+
SENSITIVE = []
|
1681
1868
|
include Aws::Structure
|
1682
1869
|
end
|
1683
1870
|
|
@@ -1686,13 +1873,14 @@ module Aws::IoTAnalytics
|
|
1686
1873
|
# @return [Types::Channel]
|
1687
1874
|
#
|
1688
1875
|
# @!attribute [rw] statistics
|
1689
|
-
# Statistics about the channel. Included if the
|
1690
|
-
# 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.
|
1691
1878
|
# @return [Types::ChannelStatistics]
|
1692
1879
|
#
|
1693
1880
|
class DescribeChannelResponse < Struct.new(
|
1694
1881
|
:channel,
|
1695
1882
|
:statistics)
|
1883
|
+
SENSITIVE = []
|
1696
1884
|
include Aws::Structure
|
1697
1885
|
end
|
1698
1886
|
|
@@ -1709,6 +1897,7 @@ module Aws::IoTAnalytics
|
|
1709
1897
|
#
|
1710
1898
|
class DescribeDatasetRequest < Struct.new(
|
1711
1899
|
:dataset_name)
|
1900
|
+
SENSITIVE = []
|
1712
1901
|
include Aws::Structure
|
1713
1902
|
end
|
1714
1903
|
|
@@ -1718,6 +1907,7 @@ module Aws::IoTAnalytics
|
|
1718
1907
|
#
|
1719
1908
|
class DescribeDatasetResponse < Struct.new(
|
1720
1909
|
:dataset)
|
1910
|
+
SENSITIVE = []
|
1721
1911
|
include Aws::Structure
|
1722
1912
|
end
|
1723
1913
|
|
@@ -1742,6 +1932,7 @@ module Aws::IoTAnalytics
|
|
1742
1932
|
class DescribeDatastoreRequest < Struct.new(
|
1743
1933
|
:datastore_name,
|
1744
1934
|
:include_statistics)
|
1935
|
+
SENSITIVE = []
|
1745
1936
|
include Aws::Structure
|
1746
1937
|
end
|
1747
1938
|
|
@@ -1751,12 +1942,13 @@ module Aws::IoTAnalytics
|
|
1751
1942
|
#
|
1752
1943
|
# @!attribute [rw] statistics
|
1753
1944
|
# Additional statistical information about the data store. Included if
|
1754
|
-
# the
|
1945
|
+
# the `includeStatistics` parameter is set to `true` in the request.
|
1755
1946
|
# @return [Types::DatastoreStatistics]
|
1756
1947
|
#
|
1757
1948
|
class DescribeDatastoreResponse < Struct.new(
|
1758
1949
|
:datastore,
|
1759
1950
|
:statistics)
|
1951
|
+
SENSITIVE = []
|
1760
1952
|
include Aws::Structure
|
1761
1953
|
end
|
1762
1954
|
|
@@ -1770,6 +1962,7 @@ module Aws::IoTAnalytics
|
|
1770
1962
|
#
|
1771
1963
|
class DescribeLoggingOptionsResponse < Struct.new(
|
1772
1964
|
:logging_options)
|
1965
|
+
SENSITIVE = []
|
1773
1966
|
include Aws::Structure
|
1774
1967
|
end
|
1775
1968
|
|
@@ -1786,15 +1979,17 @@ module Aws::IoTAnalytics
|
|
1786
1979
|
#
|
1787
1980
|
class DescribePipelineRequest < Struct.new(
|
1788
1981
|
:pipeline_name)
|
1982
|
+
SENSITIVE = []
|
1789
1983
|
include Aws::Structure
|
1790
1984
|
end
|
1791
1985
|
|
1792
1986
|
# @!attribute [rw] pipeline
|
1793
|
-
# A
|
1987
|
+
# A `Pipeline` object that contains information about the pipeline.
|
1794
1988
|
# @return [Types::Pipeline]
|
1795
1989
|
#
|
1796
1990
|
class DescribePipelineResponse < Struct.new(
|
1797
1991
|
:pipeline)
|
1992
|
+
SENSITIVE = []
|
1798
1993
|
include Aws::Structure
|
1799
1994
|
end
|
1800
1995
|
|
@@ -1813,7 +2008,7 @@ module Aws::IoTAnalytics
|
|
1813
2008
|
# }
|
1814
2009
|
#
|
1815
2010
|
# @!attribute [rw] name
|
1816
|
-
# The name of the
|
2011
|
+
# The name of the `deviceRegistryEnrich` activity.
|
1817
2012
|
# @return [String]
|
1818
2013
|
#
|
1819
2014
|
# @!attribute [rw] attribute
|
@@ -1840,10 +2035,11 @@ module Aws::IoTAnalytics
|
|
1840
2035
|
:thing_name,
|
1841
2036
|
:role_arn,
|
1842
2037
|
:next)
|
2038
|
+
SENSITIVE = []
|
1843
2039
|
include Aws::Structure
|
1844
2040
|
end
|
1845
2041
|
|
1846
|
-
# An activity that adds information from the AWS IoT Device
|
2042
|
+
# An activity that adds information from the AWS IoT Device Shadow
|
1847
2043
|
# service to a message.
|
1848
2044
|
#
|
1849
2045
|
# @note When making an API call, you may pass DeviceShadowEnrichActivity
|
@@ -1858,7 +2054,7 @@ module Aws::IoTAnalytics
|
|
1858
2054
|
# }
|
1859
2055
|
#
|
1860
2056
|
# @!attribute [rw] name
|
1861
|
-
# The name of the
|
2057
|
+
# The name of the `deviceShadowEnrich` activity.
|
1862
2058
|
# @return [String]
|
1863
2059
|
#
|
1864
2060
|
# @!attribute [rw] attribute
|
@@ -1884,13 +2080,14 @@ module Aws::IoTAnalytics
|
|
1884
2080
|
:thing_name,
|
1885
2081
|
:role_arn,
|
1886
2082
|
:next)
|
2083
|
+
SENSITIVE = []
|
1887
2084
|
include Aws::Structure
|
1888
2085
|
end
|
1889
2086
|
|
1890
2087
|
# The estimated size of the resource.
|
1891
2088
|
#
|
1892
2089
|
# @!attribute [rw] estimated_size_in_bytes
|
1893
|
-
# The estimated size of the resource in bytes.
|
2090
|
+
# The estimated size of the resource, in bytes.
|
1894
2091
|
# @return [Float]
|
1895
2092
|
#
|
1896
2093
|
# @!attribute [rw] estimated_on
|
@@ -1900,6 +2097,7 @@ module Aws::IoTAnalytics
|
|
1900
2097
|
class EstimatedResourceSize < Struct.new(
|
1901
2098
|
:estimated_size_in_bytes,
|
1902
2099
|
:estimated_on)
|
2100
|
+
SENSITIVE = []
|
1903
2101
|
include Aws::Structure
|
1904
2102
|
end
|
1905
2103
|
|
@@ -1915,12 +2113,13 @@ module Aws::IoTAnalytics
|
|
1915
2113
|
# }
|
1916
2114
|
#
|
1917
2115
|
# @!attribute [rw] name
|
1918
|
-
# The name of the
|
2116
|
+
# The name of the filter activity.
|
1919
2117
|
# @return [String]
|
1920
2118
|
#
|
1921
2119
|
# @!attribute [rw] filter
|
1922
2120
|
# An expression that looks like a SQL WHERE clause that must return a
|
1923
|
-
# Boolean value.
|
2121
|
+
# Boolean value. Messages that satisfy the condition are passed to the
|
2122
|
+
# next activity.
|
1924
2123
|
# @return [String]
|
1925
2124
|
#
|
1926
2125
|
# @!attribute [rw] next
|
@@ -1931,6 +2130,7 @@ module Aws::IoTAnalytics
|
|
1931
2130
|
:name,
|
1932
2131
|
:filter,
|
1933
2132
|
:next)
|
2133
|
+
SENSITIVE = []
|
1934
2134
|
include Aws::Structure
|
1935
2135
|
end
|
1936
2136
|
|
@@ -1956,11 +2156,12 @@ module Aws::IoTAnalytics
|
|
1956
2156
|
class GetDatasetContentRequest < Struct.new(
|
1957
2157
|
:dataset_name,
|
1958
2158
|
:version_id)
|
2159
|
+
SENSITIVE = []
|
1959
2160
|
include Aws::Structure
|
1960
2161
|
end
|
1961
2162
|
|
1962
2163
|
# @!attribute [rw] entries
|
1963
|
-
# A list of
|
2164
|
+
# A list of `DatasetEntry` objects.
|
1964
2165
|
# @return [Array<Types::DatasetEntry>]
|
1965
2166
|
#
|
1966
2167
|
# @!attribute [rw] timestamp
|
@@ -1975,11 +2176,12 @@ module Aws::IoTAnalytics
|
|
1975
2176
|
:entries,
|
1976
2177
|
:timestamp,
|
1977
2178
|
:status)
|
2179
|
+
SENSITIVE = []
|
1978
2180
|
include Aws::Structure
|
1979
2181
|
end
|
1980
2182
|
|
1981
|
-
# Configuration information for coordination with
|
1982
|
-
#
|
2183
|
+
# Configuration information for coordination with AWS Glue, a fully
|
2184
|
+
# managed extract, transform and load (ETL) service.
|
1983
2185
|
#
|
1984
2186
|
# @note When making an API call, you may pass GlueConfiguration
|
1985
2187
|
# data as a hash:
|
@@ -1990,21 +2192,21 @@ module Aws::IoTAnalytics
|
|
1990
2192
|
# }
|
1991
2193
|
#
|
1992
2194
|
# @!attribute [rw] table_name
|
1993
|
-
# The name of the table in your AWS Glue Data Catalog
|
1994
|
-
# perform the ETL
|
1995
|
-
#
|
1996
|
-
# 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.
|
1997
2198
|
# @return [String]
|
1998
2199
|
#
|
1999
2200
|
# @!attribute [rw] database_name
|
2000
2201
|
# The name of the database in your AWS Glue Data Catalog in which the
|
2001
|
-
# table is located.
|
2002
|
-
#
|
2202
|
+
# table is located. An AWS Glue Data Catalog database contains
|
2203
|
+
# metadata tables.
|
2003
2204
|
# @return [String]
|
2004
2205
|
#
|
2005
2206
|
class GlueConfiguration < Struct.new(
|
2006
2207
|
:table_name,
|
2007
2208
|
:database_name)
|
2209
|
+
SENSITIVE = []
|
2008
2210
|
include Aws::Structure
|
2009
2211
|
end
|
2010
2212
|
|
@@ -2015,6 +2217,7 @@ module Aws::IoTAnalytics
|
|
2015
2217
|
#
|
2016
2218
|
class InternalFailureException < Struct.new(
|
2017
2219
|
:message)
|
2220
|
+
SENSITIVE = []
|
2018
2221
|
include Aws::Structure
|
2019
2222
|
end
|
2020
2223
|
|
@@ -2025,10 +2228,11 @@ module Aws::IoTAnalytics
|
|
2025
2228
|
#
|
2026
2229
|
class InvalidRequestException < Struct.new(
|
2027
2230
|
:message)
|
2231
|
+
SENSITIVE = []
|
2028
2232
|
include Aws::Structure
|
2029
2233
|
end
|
2030
2234
|
|
2031
|
-
# Configuration information for delivery of
|
2235
|
+
# Configuration information for delivery of dataset contents to AWS IoT
|
2032
2236
|
# Events.
|
2033
2237
|
#
|
2034
2238
|
# @note When making an API call, you may pass IotEventsDestinationConfiguration
|
@@ -2040,18 +2244,19 @@ module Aws::IoTAnalytics
|
|
2040
2244
|
# }
|
2041
2245
|
#
|
2042
2246
|
# @!attribute [rw] input_name
|
2043
|
-
# The name of the AWS IoT Events input to which
|
2247
|
+
# The name of the AWS IoT Events input to which dataset contents are
|
2044
2248
|
# delivered.
|
2045
2249
|
# @return [String]
|
2046
2250
|
#
|
2047
2251
|
# @!attribute [rw] role_arn
|
2048
|
-
# The ARN of the role
|
2049
|
-
# deliver
|
2252
|
+
# The ARN of the role that grants AWS IoT Analytics permission to
|
2253
|
+
# deliver dataset contents to an AWS IoT Events input.
|
2050
2254
|
# @return [String]
|
2051
2255
|
#
|
2052
2256
|
class IotEventsDestinationConfiguration < Struct.new(
|
2053
2257
|
:input_name,
|
2054
2258
|
:role_arn)
|
2259
|
+
SENSITIVE = []
|
2055
2260
|
include Aws::Structure
|
2056
2261
|
end
|
2057
2262
|
|
@@ -2068,7 +2273,7 @@ module Aws::IoTAnalytics
|
|
2068
2273
|
# }
|
2069
2274
|
#
|
2070
2275
|
# @!attribute [rw] name
|
2071
|
-
# The name of the
|
2276
|
+
# The name of the lambda activity.
|
2072
2277
|
# @return [String]
|
2073
2278
|
#
|
2074
2279
|
# @!attribute [rw] lambda_name
|
@@ -2078,9 +2283,9 @@ module Aws::IoTAnalytics
|
|
2078
2283
|
# @!attribute [rw] batch_size
|
2079
2284
|
# The number of messages passed to the Lambda function for processing.
|
2080
2285
|
#
|
2081
|
-
# The
|
2082
|
-
#
|
2083
|
-
#
|
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.
|
2084
2289
|
# @return [Integer]
|
2085
2290
|
#
|
2086
2291
|
# @!attribute [rw] next
|
@@ -2092,6 +2297,58 @@ module Aws::IoTAnalytics
|
|
2092
2297
|
:lambda_name,
|
2093
2298
|
:batch_size,
|
2094
2299
|
:next)
|
2300
|
+
SENSITIVE = []
|
2301
|
+
include Aws::Structure
|
2302
|
+
end
|
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 = []
|
2095
2352
|
include Aws::Structure
|
2096
2353
|
end
|
2097
2354
|
|
@@ -2102,6 +2359,7 @@ module Aws::IoTAnalytics
|
|
2102
2359
|
#
|
2103
2360
|
class LimitExceededException < Struct.new(
|
2104
2361
|
:message)
|
2362
|
+
SENSITIVE = []
|
2105
2363
|
include Aws::Structure
|
2106
2364
|
end
|
2107
2365
|
|
@@ -2126,11 +2384,12 @@ module Aws::IoTAnalytics
|
|
2126
2384
|
class ListChannelsRequest < Struct.new(
|
2127
2385
|
:next_token,
|
2128
2386
|
:max_results)
|
2387
|
+
SENSITIVE = []
|
2129
2388
|
include Aws::Structure
|
2130
2389
|
end
|
2131
2390
|
|
2132
2391
|
# @!attribute [rw] channel_summaries
|
2133
|
-
# A list of
|
2392
|
+
# A list of `ChannelSummary` objects.
|
2134
2393
|
# @return [Array<Types::ChannelSummary>]
|
2135
2394
|
#
|
2136
2395
|
# @!attribute [rw] next_token
|
@@ -2141,6 +2400,7 @@ module Aws::IoTAnalytics
|
|
2141
2400
|
class ListChannelsResponse < Struct.new(
|
2142
2401
|
:channel_summaries,
|
2143
2402
|
:next_token)
|
2403
|
+
SENSITIVE = []
|
2144
2404
|
include Aws::Structure
|
2145
2405
|
end
|
2146
2406
|
|
@@ -2171,13 +2431,13 @@ module Aws::IoTAnalytics
|
|
2171
2431
|
# @!attribute [rw] scheduled_on_or_after
|
2172
2432
|
# A filter to limit results to those data set contents whose creation
|
2173
2433
|
# is scheduled on or after the given time. See the field
|
2174
|
-
# `triggers.schedule` in the CreateDataset request. (timestamp)
|
2434
|
+
# `triggers.schedule` in the `CreateDataset` request. (timestamp)
|
2175
2435
|
# @return [Time]
|
2176
2436
|
#
|
2177
2437
|
# @!attribute [rw] scheduled_before
|
2178
2438
|
# A filter to limit results to those data set contents whose creation
|
2179
2439
|
# is scheduled before the given time. See the field
|
2180
|
-
# `triggers.schedule` in the CreateDataset request. (timestamp)
|
2440
|
+
# `triggers.schedule` in the `CreateDataset` request. (timestamp)
|
2181
2441
|
# @return [Time]
|
2182
2442
|
#
|
2183
2443
|
class ListDatasetContentsRequest < Struct.new(
|
@@ -2186,6 +2446,7 @@ module Aws::IoTAnalytics
|
|
2186
2446
|
:max_results,
|
2187
2447
|
:scheduled_on_or_after,
|
2188
2448
|
:scheduled_before)
|
2449
|
+
SENSITIVE = []
|
2189
2450
|
include Aws::Structure
|
2190
2451
|
end
|
2191
2452
|
|
@@ -2201,6 +2462,7 @@ module Aws::IoTAnalytics
|
|
2201
2462
|
class ListDatasetContentsResponse < Struct.new(
|
2202
2463
|
:dataset_content_summaries,
|
2203
2464
|
:next_token)
|
2465
|
+
SENSITIVE = []
|
2204
2466
|
include Aws::Structure
|
2205
2467
|
end
|
2206
2468
|
|
@@ -2225,11 +2487,12 @@ module Aws::IoTAnalytics
|
|
2225
2487
|
class ListDatasetsRequest < Struct.new(
|
2226
2488
|
:next_token,
|
2227
2489
|
:max_results)
|
2490
|
+
SENSITIVE = []
|
2228
2491
|
include Aws::Structure
|
2229
2492
|
end
|
2230
2493
|
|
2231
2494
|
# @!attribute [rw] dataset_summaries
|
2232
|
-
# A list of
|
2495
|
+
# A list of `DatasetSummary` objects.
|
2233
2496
|
# @return [Array<Types::DatasetSummary>]
|
2234
2497
|
#
|
2235
2498
|
# @!attribute [rw] next_token
|
@@ -2240,6 +2503,7 @@ module Aws::IoTAnalytics
|
|
2240
2503
|
class ListDatasetsResponse < Struct.new(
|
2241
2504
|
:dataset_summaries,
|
2242
2505
|
:next_token)
|
2506
|
+
SENSITIVE = []
|
2243
2507
|
include Aws::Structure
|
2244
2508
|
end
|
2245
2509
|
|
@@ -2264,11 +2528,12 @@ module Aws::IoTAnalytics
|
|
2264
2528
|
class ListDatastoresRequest < Struct.new(
|
2265
2529
|
:next_token,
|
2266
2530
|
:max_results)
|
2531
|
+
SENSITIVE = []
|
2267
2532
|
include Aws::Structure
|
2268
2533
|
end
|
2269
2534
|
|
2270
2535
|
# @!attribute [rw] datastore_summaries
|
2271
|
-
# A list of
|
2536
|
+
# A list of `DatastoreSummary` objects.
|
2272
2537
|
# @return [Array<Types::DatastoreSummary>]
|
2273
2538
|
#
|
2274
2539
|
# @!attribute [rw] next_token
|
@@ -2279,6 +2544,7 @@ module Aws::IoTAnalytics
|
|
2279
2544
|
class ListDatastoresResponse < Struct.new(
|
2280
2545
|
:datastore_summaries,
|
2281
2546
|
:next_token)
|
2547
|
+
SENSITIVE = []
|
2282
2548
|
include Aws::Structure
|
2283
2549
|
end
|
2284
2550
|
|
@@ -2303,11 +2569,12 @@ module Aws::IoTAnalytics
|
|
2303
2569
|
class ListPipelinesRequest < Struct.new(
|
2304
2570
|
:next_token,
|
2305
2571
|
:max_results)
|
2572
|
+
SENSITIVE = []
|
2306
2573
|
include Aws::Structure
|
2307
2574
|
end
|
2308
2575
|
|
2309
2576
|
# @!attribute [rw] pipeline_summaries
|
2310
|
-
# A list of
|
2577
|
+
# A list of `PipelineSummary` objects.
|
2311
2578
|
# @return [Array<Types::PipelineSummary>]
|
2312
2579
|
#
|
2313
2580
|
# @!attribute [rw] next_token
|
@@ -2318,6 +2585,7 @@ module Aws::IoTAnalytics
|
|
2318
2585
|
class ListPipelinesResponse < Struct.new(
|
2319
2586
|
:pipeline_summaries,
|
2320
2587
|
:next_token)
|
2588
|
+
SENSITIVE = []
|
2321
2589
|
include Aws::Structure
|
2322
2590
|
end
|
2323
2591
|
|
@@ -2334,15 +2602,17 @@ module Aws::IoTAnalytics
|
|
2334
2602
|
#
|
2335
2603
|
class ListTagsForResourceRequest < Struct.new(
|
2336
2604
|
:resource_arn)
|
2605
|
+
SENSITIVE = []
|
2337
2606
|
include Aws::Structure
|
2338
2607
|
end
|
2339
2608
|
|
2340
2609
|
# @!attribute [rw] tags
|
2341
|
-
# The tags (metadata)
|
2610
|
+
# The tags (metadata) that you have assigned to the resource.
|
2342
2611
|
# @return [Array<Types::Tag>]
|
2343
2612
|
#
|
2344
2613
|
class ListTagsForResourceResponse < Struct.new(
|
2345
2614
|
:tags)
|
2615
|
+
SENSITIVE = []
|
2346
2616
|
include Aws::Structure
|
2347
2617
|
end
|
2348
2618
|
|
@@ -2363,7 +2633,7 @@ module Aws::IoTAnalytics
|
|
2363
2633
|
# @return [String]
|
2364
2634
|
#
|
2365
2635
|
# @!attribute [rw] level
|
2366
|
-
# The logging level. Currently, only
|
2636
|
+
# The logging level. Currently, only ERROR is supported.
|
2367
2637
|
# @return [String]
|
2368
2638
|
#
|
2369
2639
|
# @!attribute [rw] enabled
|
@@ -2374,6 +2644,7 @@ module Aws::IoTAnalytics
|
|
2374
2644
|
:role_arn,
|
2375
2645
|
:level,
|
2376
2646
|
:enabled)
|
2647
|
+
SENSITIVE = []
|
2377
2648
|
include Aws::Structure
|
2378
2649
|
end
|
2379
2650
|
|
@@ -2391,7 +2662,7 @@ module Aws::IoTAnalytics
|
|
2391
2662
|
# }
|
2392
2663
|
#
|
2393
2664
|
# @!attribute [rw] name
|
2394
|
-
# The name of the
|
2665
|
+
# The name of the math activity.
|
2395
2666
|
# @return [String]
|
2396
2667
|
#
|
2397
2668
|
# @!attribute [rw] attribute
|
@@ -2413,6 +2684,7 @@ module Aws::IoTAnalytics
|
|
2413
2684
|
:attribute,
|
2414
2685
|
:math,
|
2415
2686
|
:next)
|
2687
|
+
SENSITIVE = []
|
2416
2688
|
include Aws::Structure
|
2417
2689
|
end
|
2418
2690
|
|
@@ -2427,19 +2699,20 @@ module Aws::IoTAnalytics
|
|
2427
2699
|
# }
|
2428
2700
|
#
|
2429
2701
|
# @!attribute [rw] message_id
|
2430
|
-
# The ID you
|
2702
|
+
# The ID you want to assign to the message. Each `messageId` must be
|
2431
2703
|
# unique within each batch sent.
|
2432
2704
|
# @return [String]
|
2433
2705
|
#
|
2434
2706
|
# @!attribute [rw] payload
|
2435
|
-
# The payload of the message. This
|
2436
|
-
#
|
2437
|
-
# 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.
|
2438
2710
|
# @return [String]
|
2439
2711
|
#
|
2440
2712
|
class Message < Struct.new(
|
2441
2713
|
:message_id,
|
2442
2714
|
:payload)
|
2715
|
+
SENSITIVE = []
|
2443
2716
|
include Aws::Structure
|
2444
2717
|
end
|
2445
2718
|
|
@@ -2454,12 +2727,13 @@ module Aws::IoTAnalytics
|
|
2454
2727
|
# }
|
2455
2728
|
#
|
2456
2729
|
# @!attribute [rw] file_name
|
2457
|
-
# The URI of the location where
|
2730
|
+
# The URI of the location where dataset contents are stored, usually
|
2458
2731
|
# the URI of a file in an S3 bucket.
|
2459
2732
|
# @return [String]
|
2460
2733
|
#
|
2461
2734
|
class OutputFileUriValue < Struct.new(
|
2462
2735
|
:file_name)
|
2736
|
+
SENSITIVE = []
|
2463
2737
|
include Aws::Structure
|
2464
2738
|
end
|
2465
2739
|
|
@@ -2496,6 +2770,7 @@ module Aws::IoTAnalytics
|
|
2496
2770
|
:reprocessing_summaries,
|
2497
2771
|
:creation_time,
|
2498
2772
|
:last_update_time)
|
2773
|
+
SENSITIVE = []
|
2499
2774
|
include Aws::Structure
|
2500
2775
|
end
|
2501
2776
|
|
@@ -2603,7 +2878,7 @@ module Aws::IoTAnalytics
|
|
2603
2878
|
# @return [Types::DeviceRegistryEnrichActivity]
|
2604
2879
|
#
|
2605
2880
|
# @!attribute [rw] device_shadow_enrich
|
2606
|
-
# Adds information from the AWS IoT Device
|
2881
|
+
# Adds information from the AWS IoT Device Shadow service to a
|
2607
2882
|
# message.
|
2608
2883
|
# @return [Types::DeviceShadowEnrichActivity]
|
2609
2884
|
#
|
@@ -2618,6 +2893,7 @@ module Aws::IoTAnalytics
|
|
2618
2893
|
:math,
|
2619
2894
|
:device_registry_enrich,
|
2620
2895
|
:device_shadow_enrich)
|
2896
|
+
SENSITIVE = []
|
2621
2897
|
include Aws::Structure
|
2622
2898
|
end
|
2623
2899
|
|
@@ -2644,6 +2920,7 @@ module Aws::IoTAnalytics
|
|
2644
2920
|
:reprocessing_summaries,
|
2645
2921
|
:creation_time,
|
2646
2922
|
:last_update_time)
|
2923
|
+
SENSITIVE = []
|
2647
2924
|
include Aws::Structure
|
2648
2925
|
end
|
2649
2926
|
|
@@ -2664,11 +2941,12 @@ module Aws::IoTAnalytics
|
|
2664
2941
|
#
|
2665
2942
|
class PutLoggingOptionsRequest < Struct.new(
|
2666
2943
|
:logging_options)
|
2944
|
+
SENSITIVE = []
|
2667
2945
|
include Aws::Structure
|
2668
2946
|
end
|
2669
2947
|
|
2670
|
-
# Information
|
2671
|
-
# according to the
|
2948
|
+
# Information that is used to filter message data, to segregate it
|
2949
|
+
# according to the timeframe in which it arrives.
|
2672
2950
|
#
|
2673
2951
|
# @note When making an API call, you may pass QueryFilter
|
2674
2952
|
# data as a hash:
|
@@ -2687,6 +2965,7 @@ module Aws::IoTAnalytics
|
|
2687
2965
|
#
|
2688
2966
|
class QueryFilter < Struct.new(
|
2689
2967
|
:delta_time)
|
2968
|
+
SENSITIVE = []
|
2690
2969
|
include Aws::Structure
|
2691
2970
|
end
|
2692
2971
|
|
@@ -2702,7 +2981,7 @@ module Aws::IoTAnalytics
|
|
2702
2981
|
# }
|
2703
2982
|
#
|
2704
2983
|
# @!attribute [rw] name
|
2705
|
-
# The name of the
|
2984
|
+
# The name of the `removeAttributes` activity.
|
2706
2985
|
# @return [String]
|
2707
2986
|
#
|
2708
2987
|
# @!attribute [rw] attributes
|
@@ -2717,13 +2996,14 @@ module Aws::IoTAnalytics
|
|
2717
2996
|
:name,
|
2718
2997
|
:attributes,
|
2719
2998
|
:next)
|
2999
|
+
SENSITIVE = []
|
2720
3000
|
include Aws::Structure
|
2721
3001
|
end
|
2722
3002
|
|
2723
3003
|
# Information about pipeline reprocessing.
|
2724
3004
|
#
|
2725
3005
|
# @!attribute [rw] id
|
2726
|
-
# The
|
3006
|
+
# The `reprocessingId` returned by `StartPipelineReprocessing`.
|
2727
3007
|
# @return [String]
|
2728
3008
|
#
|
2729
3009
|
# @!attribute [rw] status
|
@@ -2738,6 +3018,7 @@ module Aws::IoTAnalytics
|
|
2738
3018
|
:id,
|
2739
3019
|
:status,
|
2740
3020
|
:creation_time)
|
3021
|
+
SENSITIVE = []
|
2741
3022
|
include Aws::Structure
|
2742
3023
|
end
|
2743
3024
|
|
@@ -2758,11 +3039,12 @@ module Aws::IoTAnalytics
|
|
2758
3039
|
:message,
|
2759
3040
|
:resource_id,
|
2760
3041
|
:resource_arn)
|
3042
|
+
SENSITIVE = []
|
2761
3043
|
include Aws::Structure
|
2762
3044
|
end
|
2763
3045
|
|
2764
3046
|
# The configuration of the resource used to execute the
|
2765
|
-
#
|
3047
|
+
# `containerAction`.
|
2766
3048
|
#
|
2767
3049
|
# @note When making an API call, you may pass ResourceConfiguration
|
2768
3050
|
# data as a hash:
|
@@ -2774,18 +3056,19 @@ module Aws::IoTAnalytics
|
|
2774
3056
|
#
|
2775
3057
|
# @!attribute [rw] compute_type
|
2776
3058
|
# The type of the compute resource used to execute the
|
2777
|
-
#
|
2778
|
-
#
|
3059
|
+
# `containerAction`. Possible values are: `ACU_1` (vCPU=4, memory=16
|
3060
|
+
# GiB) or `ACU_2` (vCPU=8, memory=32 GiB).
|
2779
3061
|
# @return [String]
|
2780
3062
|
#
|
2781
3063
|
# @!attribute [rw] volume_size_in_gb
|
2782
|
-
# The size
|
2783
|
-
# 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).
|
2784
3066
|
# @return [Integer]
|
2785
3067
|
#
|
2786
3068
|
class ResourceConfiguration < Struct.new(
|
2787
3069
|
:compute_type,
|
2788
3070
|
:volume_size_in_gb)
|
3071
|
+
SENSITIVE = []
|
2789
3072
|
include Aws::Structure
|
2790
3073
|
end
|
2791
3074
|
|
@@ -2796,6 +3079,7 @@ module Aws::IoTAnalytics
|
|
2796
3079
|
#
|
2797
3080
|
class ResourceNotFoundException < Struct.new(
|
2798
3081
|
:message)
|
3082
|
+
SENSITIVE = []
|
2799
3083
|
include Aws::Structure
|
2800
3084
|
end
|
2801
3085
|
|
@@ -2814,13 +3098,14 @@ module Aws::IoTAnalytics
|
|
2814
3098
|
# @return [Boolean]
|
2815
3099
|
#
|
2816
3100
|
# @!attribute [rw] number_of_days
|
2817
|
-
# The number of days that message data is kept. The
|
3101
|
+
# The number of days that message data is kept. The `unlimited`
|
2818
3102
|
# parameter must be false.
|
2819
3103
|
# @return [Integer]
|
2820
3104
|
#
|
2821
3105
|
class RetentionPeriod < Struct.new(
|
2822
3106
|
:unlimited,
|
2823
3107
|
:number_of_days)
|
3108
|
+
SENSITIVE = []
|
2824
3109
|
include Aws::Structure
|
2825
3110
|
end
|
2826
3111
|
|
@@ -2891,12 +3176,12 @@ module Aws::IoTAnalytics
|
|
2891
3176
|
# }
|
2892
3177
|
#
|
2893
3178
|
# @!attribute [rw] pipeline_activity
|
2894
|
-
# The pipeline activity that is run. This must not be a
|
2895
|
-
# activity or a
|
2896
|
-
#
|
2897
|
-
#
|
2898
|
-
#
|
2899
|
-
#
|
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.
|
2900
3185
|
# @return [Types::PipelineActivity]
|
2901
3186
|
#
|
2902
3187
|
# @!attribute [rw] payloads
|
@@ -2906,6 +3191,7 @@ module Aws::IoTAnalytics
|
|
2906
3191
|
class RunPipelineActivityRequest < Struct.new(
|
2907
3192
|
:pipeline_activity,
|
2908
3193
|
:payloads)
|
3194
|
+
SENSITIVE = []
|
2909
3195
|
include Aws::Structure
|
2910
3196
|
end
|
2911
3197
|
|
@@ -2923,11 +3209,12 @@ module Aws::IoTAnalytics
|
|
2923
3209
|
class RunPipelineActivityResponse < Struct.new(
|
2924
3210
|
:payloads,
|
2925
3211
|
:log_result)
|
3212
|
+
SENSITIVE = []
|
2926
3213
|
include Aws::Structure
|
2927
3214
|
end
|
2928
3215
|
|
2929
|
-
# Configuration information for delivery of
|
2930
|
-
# S3.
|
3216
|
+
# Configuration information for delivery of dataset contents to Amazon
|
3217
|
+
# Simple Storage Service (Amazon S3).
|
2931
3218
|
#
|
2932
3219
|
# @note When making an API call, you may pass S3DestinationConfiguration
|
2933
3220
|
# data as a hash:
|
@@ -2943,28 +3230,44 @@ module Aws::IoTAnalytics
|
|
2943
3230
|
# }
|
2944
3231
|
#
|
2945
3232
|
# @!attribute [rw] bucket
|
2946
|
-
# The name of the
|
2947
|
-
# delivered.
|
3233
|
+
# The name of the S3 bucket to which dataset contents are delivered.
|
2948
3234
|
# @return [String]
|
2949
3235
|
#
|
2950
3236
|
# @!attribute [rw] key
|
2951
|
-
# The key of the
|
2952
|
-
#
|
2953
|
-
#
|
2954
|
-
#
|
2955
|
-
#
|
2956
|
-
#
|
2957
|
-
# the
|
2958
|
-
#
|
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>
|
2959
3262
|
# @return [String]
|
2960
3263
|
#
|
2961
3264
|
# @!attribute [rw] glue_configuration
|
2962
|
-
# Configuration information for coordination with
|
2963
|
-
#
|
3265
|
+
# Configuration information for coordination with AWS Glue, a fully
|
3266
|
+
# managed extract, transform and load (ETL) service.
|
2964
3267
|
# @return [Types::GlueConfiguration]
|
2965
3268
|
#
|
2966
3269
|
# @!attribute [rw] role_arn
|
2967
|
-
# The ARN of the role
|
3270
|
+
# The ARN of the role that grants AWS IoT Analytics permission to
|
2968
3271
|
# interact with your Amazon S3 and AWS Glue resources.
|
2969
3272
|
# @return [String]
|
2970
3273
|
#
|
@@ -2973,6 +3276,7 @@ module Aws::IoTAnalytics
|
|
2973
3276
|
:key,
|
2974
3277
|
:glue_configuration,
|
2975
3278
|
:role_arn)
|
3279
|
+
SENSITIVE = []
|
2976
3280
|
include Aws::Structure
|
2977
3281
|
end
|
2978
3282
|
|
@@ -2991,7 +3295,7 @@ module Aws::IoTAnalytics
|
|
2991
3295
|
# @return [String]
|
2992
3296
|
#
|
2993
3297
|
# @!attribute [rw] max_messages
|
2994
|
-
# 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
|
2995
3299
|
# default is also 10.
|
2996
3300
|
# @return [Integer]
|
2997
3301
|
#
|
@@ -3009,6 +3313,7 @@ module Aws::IoTAnalytics
|
|
3009
3313
|
:max_messages,
|
3010
3314
|
:start_time,
|
3011
3315
|
:end_time)
|
3316
|
+
SENSITIVE = []
|
3012
3317
|
include Aws::Structure
|
3013
3318
|
end
|
3014
3319
|
|
@@ -3019,6 +3324,7 @@ module Aws::IoTAnalytics
|
|
3019
3324
|
#
|
3020
3325
|
class SampleChannelDataResponse < Struct.new(
|
3021
3326
|
:payloads)
|
3327
|
+
SENSITIVE = []
|
3022
3328
|
include Aws::Structure
|
3023
3329
|
end
|
3024
3330
|
|
@@ -3033,8 +3339,8 @@ module Aws::IoTAnalytics
|
|
3033
3339
|
#
|
3034
3340
|
# @!attribute [rw] expression
|
3035
3341
|
# The expression that defines when to trigger an update. For more
|
3036
|
-
# information, see [
|
3037
|
-
# CloudWatch Events User Guide
|
3342
|
+
# information, see [Schedule Expressions for Rules][1] in the *Amazon
|
3343
|
+
# CloudWatch Events User Guide*.
|
3038
3344
|
#
|
3039
3345
|
#
|
3040
3346
|
#
|
@@ -3043,6 +3349,7 @@ module Aws::IoTAnalytics
|
|
3043
3349
|
#
|
3044
3350
|
class Schedule < Struct.new(
|
3045
3351
|
:expression)
|
3352
|
+
SENSITIVE = []
|
3046
3353
|
include Aws::Structure
|
3047
3354
|
end
|
3048
3355
|
|
@@ -3059,7 +3366,7 @@ module Aws::IoTAnalytics
|
|
3059
3366
|
# }
|
3060
3367
|
#
|
3061
3368
|
# @!attribute [rw] name
|
3062
|
-
# The name of the
|
3369
|
+
# The name of the `selectAttributes` activity.
|
3063
3370
|
# @return [String]
|
3064
3371
|
#
|
3065
3372
|
# @!attribute [rw] attributes
|
@@ -3074,33 +3381,33 @@ module Aws::IoTAnalytics
|
|
3074
3381
|
:name,
|
3075
3382
|
:attributes,
|
3076
3383
|
:next)
|
3384
|
+
SENSITIVE = []
|
3077
3385
|
include Aws::Structure
|
3078
3386
|
end
|
3079
3387
|
|
3080
|
-
# Use this to store channel data in an S3 bucket managed by
|
3081
|
-
# Analytics
|
3082
|
-
# 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.
|
3083
3391
|
#
|
3084
3392
|
# @api private
|
3085
3393
|
#
|
3086
3394
|
class ServiceManagedChannelS3Storage < Aws::EmptyStructure; end
|
3087
3395
|
|
3088
|
-
# Used to store channel data in an S3 bucket managed by
|
3089
|
-
# Analytics
|
3396
|
+
# Used to store channel data in an S3 bucket managed by AWS IoT
|
3397
|
+
# Analytics.
|
3090
3398
|
#
|
3091
3399
|
class ServiceManagedChannelS3StorageSummary < Aws::EmptyStructure; end
|
3092
3400
|
|
3093
|
-
# Use this to store data store data in an S3 bucket managed by
|
3094
|
-
#
|
3095
|
-
# customer-managed S3 storage
|
3096
|
-
# 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.
|
3097
3404
|
#
|
3098
3405
|
# @api private
|
3099
3406
|
#
|
3100
3407
|
class ServiceManagedDatastoreS3Storage < Aws::EmptyStructure; end
|
3101
3408
|
|
3102
|
-
# Used to store data store data in an S3 bucket managed by
|
3103
|
-
# Analytics
|
3409
|
+
# Used to store data store data in an S3 bucket managed by AWS IoT
|
3410
|
+
# Analytics.
|
3104
3411
|
#
|
3105
3412
|
class ServiceManagedDatastoreS3StorageSummary < Aws::EmptyStructure; end
|
3106
3413
|
|
@@ -3111,6 +3418,7 @@ module Aws::IoTAnalytics
|
|
3111
3418
|
#
|
3112
3419
|
class ServiceUnavailableException < Struct.new(
|
3113
3420
|
:message)
|
3421
|
+
SENSITIVE = []
|
3114
3422
|
include Aws::Structure
|
3115
3423
|
end
|
3116
3424
|
|
@@ -3136,12 +3444,13 @@ module Aws::IoTAnalytics
|
|
3136
3444
|
# @return [String]
|
3137
3445
|
#
|
3138
3446
|
# @!attribute [rw] filters
|
3139
|
-
#
|
3447
|
+
# Prefilters applied to message data.
|
3140
3448
|
# @return [Array<Types::QueryFilter>]
|
3141
3449
|
#
|
3142
3450
|
class SqlQueryDatasetAction < Struct.new(
|
3143
3451
|
:sql_query,
|
3144
3452
|
:filters)
|
3453
|
+
SENSITIVE = []
|
3145
3454
|
include Aws::Structure
|
3146
3455
|
end
|
3147
3456
|
|
@@ -3170,6 +3479,7 @@ module Aws::IoTAnalytics
|
|
3170
3479
|
:pipeline_name,
|
3171
3480
|
:start_time,
|
3172
3481
|
:end_time)
|
3482
|
+
SENSITIVE = []
|
3173
3483
|
include Aws::Structure
|
3174
3484
|
end
|
3175
3485
|
|
@@ -3179,10 +3489,11 @@ module Aws::IoTAnalytics
|
|
3179
3489
|
#
|
3180
3490
|
class StartPipelineReprocessingResponse < Struct.new(
|
3181
3491
|
:reprocessing_id)
|
3492
|
+
SENSITIVE = []
|
3182
3493
|
include Aws::Structure
|
3183
3494
|
end
|
3184
3495
|
|
3185
|
-
# A set of key
|
3496
|
+
# A set of key-value pairs that are used to manage the resource.
|
3186
3497
|
#
|
3187
3498
|
# @note When making an API call, you may pass Tag
|
3188
3499
|
# data as a hash:
|
@@ -3203,6 +3514,7 @@ module Aws::IoTAnalytics
|
|
3203
3514
|
class Tag < Struct.new(
|
3204
3515
|
:key,
|
3205
3516
|
:value)
|
3517
|
+
SENSITIVE = []
|
3206
3518
|
include Aws::Structure
|
3207
3519
|
end
|
3208
3520
|
|
@@ -3230,6 +3542,7 @@ module Aws::IoTAnalytics
|
|
3230
3542
|
class TagResourceRequest < Struct.new(
|
3231
3543
|
:resource_arn,
|
3232
3544
|
:tags)
|
3545
|
+
SENSITIVE = []
|
3233
3546
|
include Aws::Structure
|
3234
3547
|
end
|
3235
3548
|
|
@@ -3242,11 +3555,12 @@ module Aws::IoTAnalytics
|
|
3242
3555
|
#
|
3243
3556
|
class ThrottlingException < Struct.new(
|
3244
3557
|
:message)
|
3558
|
+
SENSITIVE = []
|
3245
3559
|
include Aws::Structure
|
3246
3560
|
end
|
3247
3561
|
|
3248
|
-
# Information about the
|
3249
|
-
# new
|
3562
|
+
# Information about the dataset whose content generation triggers the
|
3563
|
+
# new dataset content generation.
|
3250
3564
|
#
|
3251
3565
|
# @note When making an API call, you may pass TriggeringDataset
|
3252
3566
|
# data as a hash:
|
@@ -3256,12 +3570,13 @@ module Aws::IoTAnalytics
|
|
3256
3570
|
# }
|
3257
3571
|
#
|
3258
3572
|
# @!attribute [rw] name
|
3259
|
-
# The name of the
|
3260
|
-
#
|
3573
|
+
# The name of the dataset whose content generation triggers the new
|
3574
|
+
# dataset content generation.
|
3261
3575
|
# @return [String]
|
3262
3576
|
#
|
3263
3577
|
class TriggeringDataset < Struct.new(
|
3264
3578
|
:name)
|
3579
|
+
SENSITIVE = []
|
3265
3580
|
include Aws::Structure
|
3266
3581
|
end
|
3267
3582
|
|
@@ -3284,6 +3599,7 @@ module Aws::IoTAnalytics
|
|
3284
3599
|
class UntagResourceRequest < Struct.new(
|
3285
3600
|
:resource_arn,
|
3286
3601
|
:tag_keys)
|
3602
|
+
SENSITIVE = []
|
3287
3603
|
include Aws::Structure
|
3288
3604
|
end
|
3289
3605
|
|
@@ -3314,10 +3630,10 @@ module Aws::IoTAnalytics
|
|
3314
3630
|
# @return [String]
|
3315
3631
|
#
|
3316
3632
|
# @!attribute [rw] channel_storage
|
3317
|
-
# Where channel data is stored. You
|
3318
|
-
#
|
3319
|
-
#
|
3320
|
-
#
|
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.
|
3321
3637
|
# @return [Types::ChannelStorage]
|
3322
3638
|
#
|
3323
3639
|
# @!attribute [rw] retention_period
|
@@ -3330,6 +3646,7 @@ module Aws::IoTAnalytics
|
|
3330
3646
|
:channel_name,
|
3331
3647
|
:channel_storage,
|
3332
3648
|
:retention_period)
|
3649
|
+
SENSITIVE = []
|
3333
3650
|
include Aws::Structure
|
3334
3651
|
end
|
3335
3652
|
|
@@ -3413,6 +3730,16 @@ module Aws::IoTAnalytics
|
|
3413
3730
|
# unlimited: false,
|
3414
3731
|
# max_versions: 1,
|
3415
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
|
+
# ],
|
3416
3743
|
# }
|
3417
3744
|
#
|
3418
3745
|
# @!attribute [rw] dataset_name
|
@@ -3420,39 +3747,55 @@ module Aws::IoTAnalytics
|
|
3420
3747
|
# @return [String]
|
3421
3748
|
#
|
3422
3749
|
# @!attribute [rw] actions
|
3423
|
-
# A list of
|
3750
|
+
# A list of `DatasetAction` objects.
|
3424
3751
|
# @return [Array<Types::DatasetAction>]
|
3425
3752
|
#
|
3426
3753
|
# @!attribute [rw] triggers
|
3427
|
-
# A list of
|
3428
|
-
# contain up to five
|
3754
|
+
# A list of `DatasetTrigger` objects. The list can be empty or can
|
3755
|
+
# contain up to five `DatasetTrigger` objects.
|
3429
3756
|
# @return [Array<Types::DatasetTrigger>]
|
3430
3757
|
#
|
3431
3758
|
# @!attribute [rw] content_delivery_rules
|
3432
|
-
# When
|
3759
|
+
# When dataset contents are created, they are delivered to
|
3433
3760
|
# destinations specified here.
|
3434
3761
|
# @return [Array<Types::DatasetContentDeliveryRule>]
|
3435
3762
|
#
|
3436
3763
|
# @!attribute [rw] retention_period
|
3437
|
-
# How long, in days,
|
3764
|
+
# How long, in days, dataset contents are kept for the dataset.
|
3438
3765
|
# @return [Types::RetentionPeriod]
|
3439
3766
|
#
|
3440
3767
|
# @!attribute [rw] versioning_configuration
|
3441
|
-
#
|
3768
|
+
# Optional. How many versions of dataset contents are kept. If not
|
3442
3769
|
# specified or set to null, only the latest version plus the latest
|
3443
3770
|
# succeeded version (if they are different) are kept for the time
|
3444
|
-
# period specified by the
|
3445
|
-
# information, see
|
3446
|
-
#
|
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
|
3447
3778
|
# @return [Types::VersioningConfiguration]
|
3448
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
|
+
#
|
3449
3790
|
class UpdateDatasetRequest < Struct.new(
|
3450
3791
|
:dataset_name,
|
3451
3792
|
:actions,
|
3452
3793
|
:triggers,
|
3453
3794
|
:content_delivery_rules,
|
3454
3795
|
:retention_period,
|
3455
|
-
:versioning_configuration
|
3796
|
+
:versioning_configuration,
|
3797
|
+
:late_data_rules)
|
3798
|
+
SENSITIVE = []
|
3456
3799
|
include Aws::Structure
|
3457
3800
|
end
|
3458
3801
|
|
@@ -3487,16 +3830,17 @@ module Aws::IoTAnalytics
|
|
3487
3830
|
# @return [Types::RetentionPeriod]
|
3488
3831
|
#
|
3489
3832
|
# @!attribute [rw] datastore_storage
|
3490
|
-
# Where data store data is stored. You
|
3491
|
-
#
|
3492
|
-
#
|
3493
|
-
#
|
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.
|
3494
3837
|
# @return [Types::DatastoreStorage]
|
3495
3838
|
#
|
3496
3839
|
class UpdateDatastoreRequest < Struct.new(
|
3497
3840
|
:datastore_name,
|
3498
3841
|
:retention_period,
|
3499
3842
|
:datastore_storage)
|
3843
|
+
SENSITIVE = []
|
3500
3844
|
include Aws::Structure
|
3501
3845
|
end
|
3502
3846
|
|
@@ -3573,16 +3917,16 @@ module Aws::IoTAnalytics
|
|
3573
3917
|
# @return [String]
|
3574
3918
|
#
|
3575
3919
|
# @!attribute [rw] pipeline_activities
|
3576
|
-
# A list of
|
3920
|
+
# A list of `PipelineActivity` objects. Activities perform
|
3577
3921
|
# transformations on your messages, such as removing, renaming or
|
3578
3922
|
# adding message attributes; filtering messages based on attribute
|
3579
3923
|
# values; invoking your Lambda functions on messages for advanced
|
3580
3924
|
# processing; or performing mathematical transformations to normalize
|
3581
3925
|
# device data.
|
3582
3926
|
#
|
3583
|
-
# The list can be 2-25
|
3927
|
+
# The list can be 2-25 `PipelineActivity` objects and must contain
|
3584
3928
|
# both a `channel` and a `datastore` activity. Each entry in the list
|
3585
|
-
# must contain only one activity
|
3929
|
+
# must contain only one activity. For example:
|
3586
3930
|
#
|
3587
3931
|
# `pipelineActivities = [ \{ "channel": \{ ... \} \}, \{ "lambda": \{
|
3588
3932
|
# ... \} \}, ... ]`
|
@@ -3591,13 +3935,13 @@ module Aws::IoTAnalytics
|
|
3591
3935
|
class UpdatePipelineRequest < Struct.new(
|
3592
3936
|
:pipeline_name,
|
3593
3937
|
:pipeline_activities)
|
3938
|
+
SENSITIVE = []
|
3594
3939
|
include Aws::Structure
|
3595
3940
|
end
|
3596
3941
|
|
3597
|
-
# An instance of a variable to be passed to the
|
3942
|
+
# An instance of a variable to be passed to the `containerAction`
|
3598
3943
|
# execution. Each variable must have a name and a value given by one of
|
3599
|
-
#
|
3600
|
-
# "outputFileUriValue".
|
3944
|
+
# `stringValue`, `datasetContentVersionValue`, or `outputFileUriValue`.
|
3601
3945
|
#
|
3602
3946
|
# @note When making an API call, you may pass Variable
|
3603
3947
|
# data as a hash:
|
@@ -3627,7 +3971,7 @@ module Aws::IoTAnalytics
|
|
3627
3971
|
# @return [Float]
|
3628
3972
|
#
|
3629
3973
|
# @!attribute [rw] dataset_content_version_value
|
3630
|
-
# The value of the variable as a structure that specifies a
|
3974
|
+
# The value of the variable as a structure that specifies a dataset
|
3631
3975
|
# content version.
|
3632
3976
|
# @return [Types::DatasetContentVersionValue]
|
3633
3977
|
#
|
@@ -3642,10 +3986,11 @@ module Aws::IoTAnalytics
|
|
3642
3986
|
:double_value,
|
3643
3987
|
:dataset_content_version_value,
|
3644
3988
|
:output_file_uri_value)
|
3989
|
+
SENSITIVE = []
|
3645
3990
|
include Aws::Structure
|
3646
3991
|
end
|
3647
3992
|
|
3648
|
-
# Information about the versioning of
|
3993
|
+
# Information about the versioning of dataset contents.
|
3649
3994
|
#
|
3650
3995
|
# @note When making an API call, you may pass VersioningConfiguration
|
3651
3996
|
# data as a hash:
|
@@ -3656,17 +4001,18 @@ module Aws::IoTAnalytics
|
|
3656
4001
|
# }
|
3657
4002
|
#
|
3658
4003
|
# @!attribute [rw] unlimited
|
3659
|
-
# If true, unlimited versions of
|
4004
|
+
# If true, unlimited versions of dataset contents are kept.
|
3660
4005
|
# @return [Boolean]
|
3661
4006
|
#
|
3662
4007
|
# @!attribute [rw] max_versions
|
3663
|
-
# How many versions of
|
3664
|
-
#
|
4008
|
+
# How many versions of dataset contents are kept. The `unlimited`
|
4009
|
+
# parameter must be `false`.
|
3665
4010
|
# @return [Integer]
|
3666
4011
|
#
|
3667
4012
|
class VersioningConfiguration < Struct.new(
|
3668
4013
|
:unlimited,
|
3669
4014
|
:max_versions)
|
4015
|
+
SENSITIVE = []
|
3670
4016
|
include Aws::Structure
|
3671
4017
|
end
|
3672
4018
|
|