aws-sdk-iotanalytics 1.36.0 → 1.40.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +213 -0
- data/LICENSE.txt +202 -0
- data/VERSION +1 -0
- data/lib/aws-sdk-iotanalytics.rb +2 -2
- data/lib/aws-sdk-iotanalytics/client.rb +113 -72
- data/lib/aws-sdk-iotanalytics/client_api.rb +47 -1
- data/lib/aws-sdk-iotanalytics/errors.rb +1 -1
- data/lib/aws-sdk-iotanalytics/resource.rb +1 -1
- data/lib/aws-sdk-iotanalytics/types.rb +469 -214
- metadata +11 -9
@@ -3,7 +3,7 @@
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
4
4
|
#
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
@@ -86,7 +86,11 @@ module Aws::IoTAnalytics
|
|
86
86
|
Datastore = Shapes::StructureShape.new(name: 'Datastore')
|
87
87
|
DatastoreActivity = Shapes::StructureShape.new(name: 'DatastoreActivity')
|
88
88
|
DatastoreArn = Shapes::StringShape.new(name: 'DatastoreArn')
|
89
|
+
DatastoreIotSiteWiseMultiLayerStorage = Shapes::StructureShape.new(name: 'DatastoreIotSiteWiseMultiLayerStorage')
|
90
|
+
DatastoreIotSiteWiseMultiLayerStorageSummary = Shapes::StructureShape.new(name: 'DatastoreIotSiteWiseMultiLayerStorageSummary')
|
89
91
|
DatastoreName = Shapes::StringShape.new(name: 'DatastoreName')
|
92
|
+
DatastorePartition = Shapes::StructureShape.new(name: 'DatastorePartition')
|
93
|
+
DatastorePartitions = Shapes::StructureShape.new(name: 'DatastorePartitions')
|
90
94
|
DatastoreStatistics = Shapes::StructureShape.new(name: 'DatastoreStatistics')
|
91
95
|
DatastoreStatus = Shapes::StringShape.new(name: 'DatastoreStatus')
|
92
96
|
DatastoreStorage = Shapes::StructureShape.new(name: 'DatastoreStorage')
|
@@ -133,6 +137,8 @@ module Aws::IoTAnalytics
|
|
133
137
|
InvalidRequestException = Shapes::StructureShape.new(name: 'InvalidRequestException')
|
134
138
|
IotEventsDestinationConfiguration = Shapes::StructureShape.new(name: 'IotEventsDestinationConfiguration')
|
135
139
|
IotEventsInputName = Shapes::StringShape.new(name: 'IotEventsInputName')
|
140
|
+
IotSiteWiseCustomerManagedDatastoreS3Storage = Shapes::StructureShape.new(name: 'IotSiteWiseCustomerManagedDatastoreS3Storage')
|
141
|
+
IotSiteWiseCustomerManagedDatastoreS3StorageSummary = Shapes::StructureShape.new(name: 'IotSiteWiseCustomerManagedDatastoreS3StorageSummary')
|
136
142
|
JsonConfiguration = Shapes::StructureShape.new(name: 'JsonConfiguration')
|
137
143
|
LambdaActivity = Shapes::StructureShape.new(name: 'LambdaActivity')
|
138
144
|
LambdaName = Shapes::StringShape.new(name: 'LambdaName')
|
@@ -172,6 +178,9 @@ module Aws::IoTAnalytics
|
|
172
178
|
OutputFileName = Shapes::StringShape.new(name: 'OutputFileName')
|
173
179
|
OutputFileUriValue = Shapes::StructureShape.new(name: 'OutputFileUriValue')
|
174
180
|
ParquetConfiguration = Shapes::StructureShape.new(name: 'ParquetConfiguration')
|
181
|
+
Partition = Shapes::StructureShape.new(name: 'Partition')
|
182
|
+
PartitionAttributeName = Shapes::StringShape.new(name: 'PartitionAttributeName')
|
183
|
+
Partitions = Shapes::ListShape.new(name: 'Partitions')
|
175
184
|
Pipeline = Shapes::StructureShape.new(name: 'Pipeline')
|
176
185
|
PipelineActivities = Shapes::ListShape.new(name: 'PipelineActivities')
|
177
186
|
PipelineActivity = Shapes::StructureShape.new(name: 'PipelineActivity')
|
@@ -231,6 +240,8 @@ module Aws::IoTAnalytics
|
|
231
240
|
ThrottlingException = Shapes::StructureShape.new(name: 'ThrottlingException')
|
232
241
|
TimeExpression = Shapes::StringShape.new(name: 'TimeExpression')
|
233
242
|
Timestamp = Shapes::TimestampShape.new(name: 'Timestamp')
|
243
|
+
TimestampFormat = Shapes::StringShape.new(name: 'TimestampFormat')
|
244
|
+
TimestampPartition = Shapes::StructureShape.new(name: 'TimestampPartition')
|
234
245
|
TriggeringDataset = Shapes::StructureShape.new(name: 'TriggeringDataset')
|
235
246
|
UnlimitedRetentionPeriod = Shapes::BooleanShape.new(name: 'UnlimitedRetentionPeriod')
|
236
247
|
UnlimitedVersioning = Shapes::BooleanShape.new(name: 'UnlimitedVersioning')
|
@@ -368,6 +379,7 @@ module Aws::IoTAnalytics
|
|
368
379
|
CreateDatastoreRequest.add_member(:retention_period, Shapes::ShapeRef.new(shape: RetentionPeriod, location_name: "retentionPeriod"))
|
369
380
|
CreateDatastoreRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "tags"))
|
370
381
|
CreateDatastoreRequest.add_member(:file_format_configuration, Shapes::ShapeRef.new(shape: FileFormatConfiguration, location_name: "fileFormatConfiguration"))
|
382
|
+
CreateDatastoreRequest.add_member(:datastore_partitions, Shapes::ShapeRef.new(shape: DatastorePartitions, location_name: "datastorePartitions"))
|
371
383
|
CreateDatastoreRequest.struct_class = Types::CreateDatastoreRequest
|
372
384
|
|
373
385
|
CreateDatastoreResponse.add_member(:datastore_name, Shapes::ShapeRef.new(shape: DatastoreName, location_name: "datastoreName"))
|
@@ -487,21 +499,37 @@ module Aws::IoTAnalytics
|
|
487
499
|
Datastore.add_member(:last_update_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "lastUpdateTime"))
|
488
500
|
Datastore.add_member(:last_message_arrival_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "lastMessageArrivalTime"))
|
489
501
|
Datastore.add_member(:file_format_configuration, Shapes::ShapeRef.new(shape: FileFormatConfiguration, location_name: "fileFormatConfiguration"))
|
502
|
+
Datastore.add_member(:datastore_partitions, Shapes::ShapeRef.new(shape: DatastorePartitions, location_name: "datastorePartitions"))
|
490
503
|
Datastore.struct_class = Types::Datastore
|
491
504
|
|
492
505
|
DatastoreActivity.add_member(:name, Shapes::ShapeRef.new(shape: ActivityName, required: true, location_name: "name"))
|
493
506
|
DatastoreActivity.add_member(:datastore_name, Shapes::ShapeRef.new(shape: DatastoreName, required: true, location_name: "datastoreName"))
|
494
507
|
DatastoreActivity.struct_class = Types::DatastoreActivity
|
495
508
|
|
509
|
+
DatastoreIotSiteWiseMultiLayerStorage.add_member(:customer_managed_s3_storage, Shapes::ShapeRef.new(shape: IotSiteWiseCustomerManagedDatastoreS3Storage, required: true, location_name: "customerManagedS3Storage"))
|
510
|
+
DatastoreIotSiteWiseMultiLayerStorage.struct_class = Types::DatastoreIotSiteWiseMultiLayerStorage
|
511
|
+
|
512
|
+
DatastoreIotSiteWiseMultiLayerStorageSummary.add_member(:customer_managed_s3_storage, Shapes::ShapeRef.new(shape: IotSiteWiseCustomerManagedDatastoreS3StorageSummary, location_name: "customerManagedS3Storage"))
|
513
|
+
DatastoreIotSiteWiseMultiLayerStorageSummary.struct_class = Types::DatastoreIotSiteWiseMultiLayerStorageSummary
|
514
|
+
|
515
|
+
DatastorePartition.add_member(:attribute_partition, Shapes::ShapeRef.new(shape: Partition, location_name: "attributePartition"))
|
516
|
+
DatastorePartition.add_member(:timestamp_partition, Shapes::ShapeRef.new(shape: TimestampPartition, location_name: "timestampPartition"))
|
517
|
+
DatastorePartition.struct_class = Types::DatastorePartition
|
518
|
+
|
519
|
+
DatastorePartitions.add_member(:partitions, Shapes::ShapeRef.new(shape: Partitions, location_name: "partitions"))
|
520
|
+
DatastorePartitions.struct_class = Types::DatastorePartitions
|
521
|
+
|
496
522
|
DatastoreStatistics.add_member(:size, Shapes::ShapeRef.new(shape: EstimatedResourceSize, location_name: "size"))
|
497
523
|
DatastoreStatistics.struct_class = Types::DatastoreStatistics
|
498
524
|
|
499
525
|
DatastoreStorage.add_member(:service_managed_s3, Shapes::ShapeRef.new(shape: ServiceManagedDatastoreS3Storage, location_name: "serviceManagedS3"))
|
500
526
|
DatastoreStorage.add_member(:customer_managed_s3, Shapes::ShapeRef.new(shape: CustomerManagedDatastoreS3Storage, location_name: "customerManagedS3"))
|
527
|
+
DatastoreStorage.add_member(:iot_site_wise_multi_layer_storage, Shapes::ShapeRef.new(shape: DatastoreIotSiteWiseMultiLayerStorage, location_name: "iotSiteWiseMultiLayerStorage"))
|
501
528
|
DatastoreStorage.struct_class = Types::DatastoreStorage
|
502
529
|
|
503
530
|
DatastoreStorageSummary.add_member(:service_managed_s3, Shapes::ShapeRef.new(shape: ServiceManagedDatastoreS3StorageSummary, location_name: "serviceManagedS3"))
|
504
531
|
DatastoreStorageSummary.add_member(:customer_managed_s3, Shapes::ShapeRef.new(shape: CustomerManagedDatastoreS3StorageSummary, location_name: "customerManagedS3"))
|
532
|
+
DatastoreStorageSummary.add_member(:iot_site_wise_multi_layer_storage, Shapes::ShapeRef.new(shape: DatastoreIotSiteWiseMultiLayerStorageSummary, location_name: "iotSiteWiseMultiLayerStorage"))
|
505
533
|
DatastoreStorageSummary.struct_class = Types::DatastoreStorageSummary
|
506
534
|
|
507
535
|
DatastoreSummaries.member = Shapes::ShapeRef.new(shape: DatastoreSummary)
|
@@ -513,6 +541,7 @@ module Aws::IoTAnalytics
|
|
513
541
|
DatastoreSummary.add_member(:last_update_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "lastUpdateTime"))
|
514
542
|
DatastoreSummary.add_member(:last_message_arrival_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "lastMessageArrivalTime"))
|
515
543
|
DatastoreSummary.add_member(:file_format_type, Shapes::ShapeRef.new(shape: FileFormatType, location_name: "fileFormatType"))
|
544
|
+
DatastoreSummary.add_member(:datastore_partitions, Shapes::ShapeRef.new(shape: DatastorePartitions, location_name: "datastorePartitions"))
|
516
545
|
DatastoreSummary.struct_class = Types::DatastoreSummary
|
517
546
|
|
518
547
|
DeleteChannelRequest.add_member(:channel_name, Shapes::ShapeRef.new(shape: ChannelName, required: true, location: "uri", location_name: "channelName"))
|
@@ -621,6 +650,14 @@ module Aws::IoTAnalytics
|
|
621
650
|
IotEventsDestinationConfiguration.add_member(:role_arn, Shapes::ShapeRef.new(shape: RoleArn, required: true, location_name: "roleArn"))
|
622
651
|
IotEventsDestinationConfiguration.struct_class = Types::IotEventsDestinationConfiguration
|
623
652
|
|
653
|
+
IotSiteWiseCustomerManagedDatastoreS3Storage.add_member(:bucket, Shapes::ShapeRef.new(shape: BucketName, required: true, location_name: "bucket"))
|
654
|
+
IotSiteWiseCustomerManagedDatastoreS3Storage.add_member(:key_prefix, Shapes::ShapeRef.new(shape: S3KeyPrefix, location_name: "keyPrefix"))
|
655
|
+
IotSiteWiseCustomerManagedDatastoreS3Storage.struct_class = Types::IotSiteWiseCustomerManagedDatastoreS3Storage
|
656
|
+
|
657
|
+
IotSiteWiseCustomerManagedDatastoreS3StorageSummary.add_member(:bucket, Shapes::ShapeRef.new(shape: BucketName, location_name: "bucket"))
|
658
|
+
IotSiteWiseCustomerManagedDatastoreS3StorageSummary.add_member(:key_prefix, Shapes::ShapeRef.new(shape: S3KeyPrefix, location_name: "keyPrefix"))
|
659
|
+
IotSiteWiseCustomerManagedDatastoreS3StorageSummary.struct_class = Types::IotSiteWiseCustomerManagedDatastoreS3StorageSummary
|
660
|
+
|
624
661
|
JsonConfiguration.struct_class = Types::JsonConfiguration
|
625
662
|
|
626
663
|
LambdaActivity.add_member(:name, Shapes::ShapeRef.new(shape: ActivityName, required: true, location_name: "name"))
|
@@ -715,6 +752,11 @@ module Aws::IoTAnalytics
|
|
715
752
|
ParquetConfiguration.add_member(:schema_definition, Shapes::ShapeRef.new(shape: SchemaDefinition, location_name: "schemaDefinition"))
|
716
753
|
ParquetConfiguration.struct_class = Types::ParquetConfiguration
|
717
754
|
|
755
|
+
Partition.add_member(:attribute_name, Shapes::ShapeRef.new(shape: PartitionAttributeName, required: true, location_name: "attributeName"))
|
756
|
+
Partition.struct_class = Types::Partition
|
757
|
+
|
758
|
+
Partitions.member = Shapes::ShapeRef.new(shape: DatastorePartition)
|
759
|
+
|
718
760
|
Pipeline.add_member(:name, Shapes::ShapeRef.new(shape: PipelineName, location_name: "name"))
|
719
761
|
Pipeline.add_member(:arn, Shapes::ShapeRef.new(shape: PipelineArn, location_name: "arn"))
|
720
762
|
Pipeline.add_member(:activities, Shapes::ShapeRef.new(shape: PipelineActivities, location_name: "activities"))
|
@@ -858,6 +900,10 @@ module Aws::IoTAnalytics
|
|
858
900
|
ThrottlingException.add_member(:message, Shapes::ShapeRef.new(shape: errorMessage, location_name: "message"))
|
859
901
|
ThrottlingException.struct_class = Types::ThrottlingException
|
860
902
|
|
903
|
+
TimestampPartition.add_member(:attribute_name, Shapes::ShapeRef.new(shape: PartitionAttributeName, required: true, location_name: "attributeName"))
|
904
|
+
TimestampPartition.add_member(:timestamp_format, Shapes::ShapeRef.new(shape: TimestampFormat, location_name: "timestampFormat"))
|
905
|
+
TimestampPartition.struct_class = Types::TimestampPartition
|
906
|
+
|
861
907
|
TriggeringDataset.add_member(:name, Shapes::ShapeRef.new(shape: DatasetName, required: true, location_name: "name"))
|
862
908
|
TriggeringDataset.struct_class = Types::TriggeringDataset
|
863
909
|
|
@@ -3,7 +3,7 @@
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
4
4
|
#
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
@@ -3,7 +3,7 @@
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
4
4
|
#
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
@@ -3,7 +3,7 @@
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
4
4
|
#
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
@@ -94,7 +94,7 @@ module Aws::IoTAnalytics
|
|
94
94
|
# The list of messages to be sent. Each message has the format: \\\{
|
95
95
|
# "messageId": "string", "payload": "string"\\}.
|
96
96
|
#
|
97
|
-
# The field names of message payloads (data) that you send to
|
97
|
+
# The field names of message payloads (data) that you send to IoT
|
98
98
|
# Analytics:
|
99
99
|
#
|
100
100
|
# * Must contain only alphanumeric characters and undescores (\_). No
|
@@ -171,7 +171,7 @@ module Aws::IoTAnalytics
|
|
171
171
|
# @!attribute [rw] storage
|
172
172
|
# Where channel data is stored. You can choose one of
|
173
173
|
# `serviceManagedS3` or `customerManagedS3` storage. If not specified,
|
174
|
-
# the default is `serviceManagedS3`. You
|
174
|
+
# the default is `serviceManagedS3`. You can't change this storage
|
175
175
|
# option after the channel is created.
|
176
176
|
# @return [Types::ChannelStorage]
|
177
177
|
#
|
@@ -198,7 +198,7 @@ module Aws::IoTAnalytics
|
|
198
198
|
# @!attribute [rw] last_message_arrival_time
|
199
199
|
# The last time when a new message arrived in the channel.
|
200
200
|
#
|
201
|
-
#
|
201
|
+
# IoT Analytics updates this value at most once per minute for one
|
202
202
|
# channel. Hence, the `lastMessageArrivalTime` value is an
|
203
203
|
# approximation.
|
204
204
|
#
|
@@ -263,6 +263,11 @@ module Aws::IoTAnalytics
|
|
263
263
|
# @!attribute [rw] s3_paths
|
264
264
|
# Specifies one or more keys that identify the Amazon Simple Storage
|
265
265
|
# Service (Amazon S3) objects that save your channel messages.
|
266
|
+
#
|
267
|
+
# You must use the full path for the key.
|
268
|
+
#
|
269
|
+
# Example path: `channel/mychannel/__dt=2020-02-29
|
270
|
+
# 00:00:00/1582940490000_1582940520000_123456789012_mychannel_0_2118.0.json.gz`
|
266
271
|
# @return [Array<String>]
|
267
272
|
#
|
268
273
|
class ChannelMessages < Struct.new(
|
@@ -283,10 +288,10 @@ module Aws::IoTAnalytics
|
|
283
288
|
include Aws::Structure
|
284
289
|
end
|
285
290
|
|
286
|
-
# Where channel data is stored. You may choose one of
|
287
|
-
#
|
288
|
-
# `serviceManagedS3`. This
|
289
|
-
# channel.
|
291
|
+
# Where channel data is stored. You may choose one of
|
292
|
+
# `serviceManagedS3`, `customerManagedS3` storage. If not specified, the
|
293
|
+
# default is `serviceManagedS3`. This can't be changed after creation
|
294
|
+
# of the channel.
|
290
295
|
#
|
291
296
|
# @note When making an API call, you may pass ChannelStorage
|
292
297
|
# data as a hash:
|
@@ -302,17 +307,16 @@ module Aws::IoTAnalytics
|
|
302
307
|
# }
|
303
308
|
#
|
304
309
|
# @!attribute [rw] service_managed_s3
|
305
|
-
#
|
306
|
-
#
|
307
|
-
#
|
310
|
+
# Used to store channel data in an S3 bucket managed by IoT Analytics.
|
311
|
+
# You can't change the choice of S3 storage after the data store is
|
312
|
+
# created.
|
308
313
|
# @return [Types::ServiceManagedChannelS3Storage]
|
309
314
|
#
|
310
315
|
# @!attribute [rw] customer_managed_s3
|
311
|
-
#
|
316
|
+
# Used to store channel data in an S3 bucket that you manage. If
|
312
317
|
# customer managed storage is selected, the `retentionPeriod`
|
313
|
-
# parameter is ignored. You
|
314
|
-
#
|
315
|
-
# created.
|
318
|
+
# parameter is ignored. You can't change the choice of S3 storage
|
319
|
+
# after the data store is created.
|
316
320
|
# @return [Types::CustomerManagedChannelS3Storage]
|
317
321
|
#
|
318
322
|
class ChannelStorage < Struct.new(
|
@@ -325,8 +329,7 @@ module Aws::IoTAnalytics
|
|
325
329
|
# Where channel data is stored.
|
326
330
|
#
|
327
331
|
# @!attribute [rw] service_managed_s3
|
328
|
-
# Used to store channel data in an S3 bucket managed by
|
329
|
-
# Analytics.
|
332
|
+
# Used to store channel data in an S3 bucket managed by IoT Analytics.
|
330
333
|
# @return [Types::ServiceManagedChannelS3StorageSummary]
|
331
334
|
#
|
332
335
|
# @!attribute [rw] customer_managed_s3
|
@@ -365,7 +368,7 @@ module Aws::IoTAnalytics
|
|
365
368
|
# @!attribute [rw] last_message_arrival_time
|
366
369
|
# The last time when a new message arrived in the channel.
|
367
370
|
#
|
368
|
-
#
|
371
|
+
# IoT Analytics updates this value at most once per minute for one
|
369
372
|
# channel. Hence, the `lastMessageArrivalTime` value is an
|
370
373
|
# approximation.
|
371
374
|
#
|
@@ -400,7 +403,7 @@ module Aws::IoTAnalytics
|
|
400
403
|
#
|
401
404
|
# @!attribute [rw] type
|
402
405
|
# The type of data. For more information about the supported data
|
403
|
-
# types, see [Common data types][1] in the *
|
406
|
+
# types, see [Common data types][1] in the *Glue Developer Guide*.
|
404
407
|
#
|
405
408
|
#
|
406
409
|
#
|
@@ -509,7 +512,7 @@ module Aws::IoTAnalytics
|
|
509
512
|
# @!attribute [rw] channel_storage
|
510
513
|
# Where channel data is stored. You can choose one of
|
511
514
|
# `serviceManagedS3` or `customerManagedS3` storage. If not specified,
|
512
|
-
# the default is `serviceManagedS3`. You
|
515
|
+
# the default is `serviceManagedS3`. You can't change this storage
|
513
516
|
# option after the channel is created.
|
514
517
|
# @return [Types::ChannelStorage]
|
515
518
|
#
|
@@ -688,16 +691,16 @@ module Aws::IoTAnalytics
|
|
688
691
|
# }
|
689
692
|
#
|
690
693
|
# @!attribute [rw] dataset_name
|
691
|
-
# The name of the
|
694
|
+
# The name of the dataset.
|
692
695
|
# @return [String]
|
693
696
|
#
|
694
697
|
# @!attribute [rw] actions
|
695
|
-
# A list of actions that create the
|
698
|
+
# A list of actions that create the dataset contents.
|
696
699
|
# @return [Array<Types::DatasetAction>]
|
697
700
|
#
|
698
701
|
# @!attribute [rw] triggers
|
699
|
-
# A list of triggers. A trigger causes
|
700
|
-
# populated at a specified time interval or when another
|
702
|
+
# A list of triggers. A trigger causes dataset contents to be
|
703
|
+
# populated at a specified time interval or when another dataset's
|
701
704
|
# contents are created. The list of triggers can be empty or contain
|
702
705
|
# up to five `DataSetTrigger` objects.
|
703
706
|
# @return [Array<Types::DatasetTrigger>]
|
@@ -712,9 +715,9 @@ module Aws::IoTAnalytics
|
|
712
715
|
# for the dataset. If not specified or set to `null`, versions of
|
713
716
|
# dataset contents are retained for at most 90 days. The number of
|
714
717
|
# versions of dataset contents retained is determined by the
|
715
|
-
# `versioningConfiguration` parameter. For more information, see
|
716
|
-
#
|
717
|
-
#
|
718
|
+
# `versioningConfiguration` parameter. For more information, see [
|
719
|
+
# Keeping Multiple Versions of IoT Analytics datasets][1] in the *IoT
|
720
|
+
# Analytics User Guide*.
|
718
721
|
#
|
719
722
|
#
|
720
723
|
#
|
@@ -726,8 +729,8 @@ module Aws::IoTAnalytics
|
|
726
729
|
# specified or set to null, only the latest version plus the latest
|
727
730
|
# succeeded version (if they are different) are kept for the time
|
728
731
|
# period specified by the `retentionPeriod` parameter. For more
|
729
|
-
# information, see [Keeping Multiple Versions of
|
730
|
-
#
|
732
|
+
# information, see [Keeping Multiple Versions of IoT Analytics
|
733
|
+
# datasets][1] in the *IoT Analytics User Guide*.
|
731
734
|
#
|
732
735
|
#
|
733
736
|
#
|
@@ -735,13 +738,13 @@ module Aws::IoTAnalytics
|
|
735
738
|
# @return [Types::VersioningConfiguration]
|
736
739
|
#
|
737
740
|
# @!attribute [rw] tags
|
738
|
-
# Metadata which can be used to manage the
|
741
|
+
# Metadata which can be used to manage the dataset.
|
739
742
|
# @return [Array<Types::Tag>]
|
740
743
|
#
|
741
744
|
# @!attribute [rw] late_data_rules
|
742
|
-
# A list of data rules that send notifications to
|
743
|
-
#
|
744
|
-
#
|
745
|
+
# A list of data rules that send notifications to CloudWatch, when
|
746
|
+
# data arrives late. To specify `lateDataRules`, the dataset must use
|
747
|
+
# a [DeltaTimer][1] filter.
|
745
748
|
#
|
746
749
|
#
|
747
750
|
#
|
@@ -794,6 +797,12 @@ module Aws::IoTAnalytics
|
|
794
797
|
# key_prefix: "S3KeyPrefix",
|
795
798
|
# role_arn: "RoleArn", # required
|
796
799
|
# },
|
800
|
+
# iot_site_wise_multi_layer_storage: {
|
801
|
+
# customer_managed_s3_storage: { # required
|
802
|
+
# bucket: "BucketName", # required
|
803
|
+
# key_prefix: "S3KeyPrefix",
|
804
|
+
# },
|
805
|
+
# },
|
797
806
|
# },
|
798
807
|
# retention_period: {
|
799
808
|
# unlimited: false,
|
@@ -819,6 +828,19 @@ module Aws::IoTAnalytics
|
|
819
828
|
# },
|
820
829
|
# },
|
821
830
|
# },
|
831
|
+
# datastore_partitions: {
|
832
|
+
# partitions: [
|
833
|
+
# {
|
834
|
+
# attribute_partition: {
|
835
|
+
# attribute_name: "PartitionAttributeName", # required
|
836
|
+
# },
|
837
|
+
# timestamp_partition: {
|
838
|
+
# attribute_name: "PartitionAttributeName", # required
|
839
|
+
# timestamp_format: "TimestampFormat",
|
840
|
+
# },
|
841
|
+
# },
|
842
|
+
# ],
|
843
|
+
# },
|
822
844
|
# }
|
823
845
|
#
|
824
846
|
# @!attribute [rw] datastore_name
|
@@ -826,10 +848,11 @@ module Aws::IoTAnalytics
|
|
826
848
|
# @return [String]
|
827
849
|
#
|
828
850
|
# @!attribute [rw] datastore_storage
|
829
|
-
# Where data
|
830
|
-
# `serviceManagedS3`
|
831
|
-
#
|
832
|
-
#
|
851
|
+
# Where data in a data store is stored.. You can choose
|
852
|
+
# `serviceManagedS3` storage, `customerManagedS3` storage, or
|
853
|
+
# `iotSiteWiseMultiLayerStorage` storage. The default is
|
854
|
+
# `serviceManagedS3`. You can't change the choice of Amazon S3
|
855
|
+
# storage after your data store is created.
|
833
856
|
# @return [Types::DatastoreStorage]
|
834
857
|
#
|
835
858
|
# @!attribute [rw] retention_period
|
@@ -842,7 +865,7 @@ module Aws::IoTAnalytics
|
|
842
865
|
# @return [Array<Types::Tag>]
|
843
866
|
#
|
844
867
|
# @!attribute [rw] file_format_configuration
|
845
|
-
# Contains the configuration information of file formats.
|
868
|
+
# Contains the configuration information of file formats. IoT
|
846
869
|
# Analytics data stores support JSON and [Parquet][1].
|
847
870
|
#
|
848
871
|
# The default file format is JSON. You can specify only one format.
|
@@ -854,12 +877,17 @@ module Aws::IoTAnalytics
|
|
854
877
|
# [1]: https://parquet.apache.org/
|
855
878
|
# @return [Types::FileFormatConfiguration]
|
856
879
|
#
|
880
|
+
# @!attribute [rw] datastore_partitions
|
881
|
+
# Contains information about the partition dimensions in a data store.
|
882
|
+
# @return [Types::DatastorePartitions]
|
883
|
+
#
|
857
884
|
class CreateDatastoreRequest < Struct.new(
|
858
885
|
:datastore_name,
|
859
886
|
:datastore_storage,
|
860
887
|
:retention_period,
|
861
888
|
:tags,
|
862
|
-
:file_format_configuration
|
889
|
+
:file_format_configuration,
|
890
|
+
:datastore_partitions)
|
863
891
|
SENSITIVE = []
|
864
892
|
include Aws::Structure
|
865
893
|
end
|
@@ -966,7 +994,7 @@ module Aws::IoTAnalytics
|
|
966
994
|
# A list of `PipelineActivity` objects. Activities perform
|
967
995
|
# transformations on your messages, such as removing, renaming or
|
968
996
|
# adding message attributes; filtering messages based on attribute
|
969
|
-
# values; invoking your Lambda
|
997
|
+
# values; invoking your Lambda unctions on messages for advanced
|
970
998
|
# processing; or performing mathematical transformations to normalize
|
971
999
|
# device data.
|
972
1000
|
#
|
@@ -1005,10 +1033,10 @@ module Aws::IoTAnalytics
|
|
1005
1033
|
include Aws::Structure
|
1006
1034
|
end
|
1007
1035
|
|
1008
|
-
#
|
1009
|
-
# customer
|
1010
|
-
# is ignored. You
|
1011
|
-
#
|
1036
|
+
# Used to store channel data in an S3 bucket that you manage. If
|
1037
|
+
# customer-managed storage is selected, the `retentionPeriod` parameter
|
1038
|
+
# is ignored. You can't change the choice of S3 storage after the data
|
1039
|
+
# store is created.
|
1012
1040
|
#
|
1013
1041
|
# @note When making an API call, you may pass CustomerManagedChannelS3Storage
|
1014
1042
|
# data as a hash:
|
@@ -1024,15 +1052,15 @@ module Aws::IoTAnalytics
|
|
1024
1052
|
# @return [String]
|
1025
1053
|
#
|
1026
1054
|
# @!attribute [rw] key_prefix
|
1027
|
-
# Optional
|
1055
|
+
# (Optional) The prefix used to create the keys of the channel data
|
1028
1056
|
# objects. Each object in an S3 bucket has a key that is its unique
|
1029
1057
|
# identifier in the bucket. Each object in a bucket has exactly one
|
1030
1058
|
# key. The prefix must end with a forward slash (/).
|
1031
1059
|
# @return [String]
|
1032
1060
|
#
|
1033
1061
|
# @!attribute [rw] role_arn
|
1034
|
-
# The ARN of the role that grants
|
1035
|
-
#
|
1062
|
+
# The ARN of the role that grants IoT Analytics permission to interact
|
1063
|
+
# with your Amazon S3 resources.
|
1036
1064
|
# @return [String]
|
1037
1065
|
#
|
1038
1066
|
class CustomerManagedChannelS3Storage < Struct.new(
|
@@ -1050,15 +1078,15 @@ module Aws::IoTAnalytics
|
|
1050
1078
|
# @return [String]
|
1051
1079
|
#
|
1052
1080
|
# @!attribute [rw] key_prefix
|
1053
|
-
# Optional
|
1081
|
+
# (Optional) The prefix used to create the keys of the channel data
|
1054
1082
|
# objects. Each object in an S3 bucket has a key that is its unique
|
1055
1083
|
# identifier within the bucket (each object in a bucket has exactly
|
1056
1084
|
# one key). The prefix must end with a forward slash (/).
|
1057
1085
|
# @return [String]
|
1058
1086
|
#
|
1059
1087
|
# @!attribute [rw] role_arn
|
1060
|
-
# The ARN of the role that grants
|
1061
|
-
#
|
1088
|
+
# The ARN of the role that grants IoT Analytics permission to interact
|
1089
|
+
# with your Amazon S3 resources.
|
1062
1090
|
# @return [String]
|
1063
1091
|
#
|
1064
1092
|
class CustomerManagedChannelS3StorageSummary < Struct.new(
|
@@ -1069,10 +1097,9 @@ module Aws::IoTAnalytics
|
|
1069
1097
|
include Aws::Structure
|
1070
1098
|
end
|
1071
1099
|
|
1072
|
-
#
|
1073
|
-
#
|
1074
|
-
#
|
1075
|
-
# or customer-managed S3 storage after the data store is created.
|
1100
|
+
# S3-customer-managed; When you choose customer-managed storage, the
|
1101
|
+
# `retentionPeriod` parameter is ignored. You can't change the choice
|
1102
|
+
# of Amazon S3 storage after your data store is created.
|
1076
1103
|
#
|
1077
1104
|
# @note When making an API call, you may pass CustomerManagedDatastoreS3Storage
|
1078
1105
|
# data as a hash:
|
@@ -1084,19 +1111,19 @@ module Aws::IoTAnalytics
|
|
1084
1111
|
# }
|
1085
1112
|
#
|
1086
1113
|
# @!attribute [rw] bucket
|
1087
|
-
# The name of the S3 bucket
|
1114
|
+
# The name of the Amazon S3 bucket where your data is stored.
|
1088
1115
|
# @return [String]
|
1089
1116
|
#
|
1090
1117
|
# @!attribute [rw] key_prefix
|
1091
|
-
# Optional
|
1092
|
-
# objects. Each object in an S3 bucket has a key that is its
|
1093
|
-
# identifier in the bucket. Each object in a bucket has exactly
|
1094
|
-
# key. The prefix must end with a forward slash (/).
|
1118
|
+
# (Optional) The prefix used to create the keys of the data store data
|
1119
|
+
# objects. Each object in an Amazon S3 bucket has a key that is its
|
1120
|
+
# unique identifier in the bucket. Each object in a bucket has exactly
|
1121
|
+
# one key. The prefix must end with a forward slash (/).
|
1095
1122
|
# @return [String]
|
1096
1123
|
#
|
1097
1124
|
# @!attribute [rw] role_arn
|
1098
|
-
# The ARN of the role that grants
|
1099
|
-
#
|
1125
|
+
# The ARN of the role that grants IoT Analytics permission to interact
|
1126
|
+
# with your Amazon S3 resources.
|
1100
1127
|
# @return [String]
|
1101
1128
|
#
|
1102
1129
|
class CustomerManagedDatastoreS3Storage < Struct.new(
|
@@ -1107,22 +1134,22 @@ module Aws::IoTAnalytics
|
|
1107
1134
|
include Aws::Structure
|
1108
1135
|
end
|
1109
1136
|
|
1110
|
-
#
|
1137
|
+
# Contains information about the data store that you manage.
|
1111
1138
|
#
|
1112
1139
|
# @!attribute [rw] bucket
|
1113
|
-
# The name of the S3 bucket
|
1140
|
+
# The name of the Amazon S3 bucket where your data is stored.
|
1114
1141
|
# @return [String]
|
1115
1142
|
#
|
1116
1143
|
# @!attribute [rw] key_prefix
|
1117
|
-
# Optional
|
1118
|
-
# objects. Each object in an S3 bucket has a key that is its
|
1119
|
-
# identifier in the bucket. Each object in a bucket has exactly
|
1120
|
-
# key. The prefix must end with a forward slash (/).
|
1144
|
+
# (Optional) The prefix used to create the keys of the data store data
|
1145
|
+
# objects. Each object in an Amazon S3 bucket has a key that is its
|
1146
|
+
# unique identifier in the bucket. Each object in a bucket has exactly
|
1147
|
+
# one key. The prefix must end with a forward slash (/).
|
1121
1148
|
# @return [String]
|
1122
1149
|
#
|
1123
1150
|
# @!attribute [rw] role_arn
|
1124
|
-
# The ARN of the role that grants
|
1125
|
-
#
|
1151
|
+
# The ARN of the role that grants IoT Analytics permission to interact
|
1152
|
+
# with your Amazon S3 resources.
|
1126
1153
|
# @return [String]
|
1127
1154
|
#
|
1128
1155
|
class CustomerManagedDatastoreS3StorageSummary < Struct.new(
|
@@ -1133,23 +1160,23 @@ module Aws::IoTAnalytics
|
|
1133
1160
|
include Aws::Structure
|
1134
1161
|
end
|
1135
1162
|
|
1136
|
-
# Information about a
|
1163
|
+
# Information about a dataset.
|
1137
1164
|
#
|
1138
1165
|
# @!attribute [rw] name
|
1139
|
-
# The name of the
|
1166
|
+
# The name of the dataset.
|
1140
1167
|
# @return [String]
|
1141
1168
|
#
|
1142
1169
|
# @!attribute [rw] arn
|
1143
|
-
# The ARN of the
|
1170
|
+
# The ARN of the dataset.
|
1144
1171
|
# @return [String]
|
1145
1172
|
#
|
1146
1173
|
# @!attribute [rw] actions
|
1147
|
-
# The `DatasetAction` objects that automatically create the
|
1174
|
+
# The `DatasetAction` objects that automatically create the dataset
|
1148
1175
|
# contents.
|
1149
1176
|
# @return [Array<Types::DatasetAction>]
|
1150
1177
|
#
|
1151
1178
|
# @!attribute [rw] triggers
|
1152
|
-
# The `DatasetTrigger` objects that specify when the
|
1179
|
+
# The `DatasetTrigger` objects that specify when the dataset is
|
1153
1180
|
# automatically updated.
|
1154
1181
|
# @return [Array<Types::DatasetTrigger>]
|
1155
1182
|
#
|
@@ -1159,19 +1186,19 @@ module Aws::IoTAnalytics
|
|
1159
1186
|
# @return [Array<Types::DatasetContentDeliveryRule>]
|
1160
1187
|
#
|
1161
1188
|
# @!attribute [rw] status
|
1162
|
-
# The status of the
|
1189
|
+
# The status of the dataset.
|
1163
1190
|
# @return [String]
|
1164
1191
|
#
|
1165
1192
|
# @!attribute [rw] creation_time
|
1166
|
-
# When the
|
1193
|
+
# When the dataset was created.
|
1167
1194
|
# @return [Time]
|
1168
1195
|
#
|
1169
1196
|
# @!attribute [rw] last_update_time
|
1170
|
-
# The last time the
|
1197
|
+
# The last time the dataset was updated.
|
1171
1198
|
# @return [Time]
|
1172
1199
|
#
|
1173
1200
|
# @!attribute [rw] retention_period
|
1174
|
-
# Optional. How long, in days, message data is kept for the
|
1201
|
+
# Optional. How long, in days, message data is kept for the dataset.
|
1175
1202
|
# @return [Types::RetentionPeriod]
|
1176
1203
|
#
|
1177
1204
|
# @!attribute [rw] versioning_configuration
|
@@ -1179,8 +1206,8 @@ module Aws::IoTAnalytics
|
|
1179
1206
|
# specified or set to null, only the latest version plus the latest
|
1180
1207
|
# succeeded version (if they are different) are kept for the time
|
1181
1208
|
# period specified by the `retentionPeriod` parameter. For more
|
1182
|
-
# information, see [Keeping Multiple Versions of
|
1183
|
-
#
|
1209
|
+
# information, see [ Keeping Multiple Versions of IoT Analytics
|
1210
|
+
# datasets][1] in the *IoT Analytics User Guide*.
|
1184
1211
|
#
|
1185
1212
|
#
|
1186
1213
|
#
|
@@ -1188,9 +1215,9 @@ module Aws::IoTAnalytics
|
|
1188
1215
|
# @return [Types::VersioningConfiguration]
|
1189
1216
|
#
|
1190
1217
|
# @!attribute [rw] late_data_rules
|
1191
|
-
# A list of data rules that send notifications to
|
1192
|
-
#
|
1193
|
-
#
|
1218
|
+
# A list of data rules that send notifications to CloudWatch, when
|
1219
|
+
# data arrives late. To specify `lateDataRules`, the dataset must use
|
1220
|
+
# a [DeltaTimer][1] filter.
|
1194
1221
|
#
|
1195
1222
|
#
|
1196
1223
|
#
|
@@ -1213,7 +1240,7 @@ module Aws::IoTAnalytics
|
|
1213
1240
|
include Aws::Structure
|
1214
1241
|
end
|
1215
1242
|
|
1216
|
-
# A `DatasetAction` object that specifies how
|
1243
|
+
# A `DatasetAction` object that specifies how dataset contents are
|
1217
1244
|
# automatically created.
|
1218
1245
|
#
|
1219
1246
|
# @note When making an API call, you may pass DatasetAction
|
@@ -1256,13 +1283,13 @@ module Aws::IoTAnalytics
|
|
1256
1283
|
# }
|
1257
1284
|
#
|
1258
1285
|
# @!attribute [rw] action_name
|
1259
|
-
# The name of the
|
1286
|
+
# The name of the dataset action by which dataset contents are
|
1260
1287
|
# automatically created.
|
1261
1288
|
# @return [String]
|
1262
1289
|
#
|
1263
1290
|
# @!attribute [rw] query_action
|
1264
1291
|
# An `SqlQueryDatasetAction` object that uses an SQL query to
|
1265
|
-
# automatically create
|
1292
|
+
# automatically create dataset contents.
|
1266
1293
|
# @return [Types::SqlQueryDatasetAction]
|
1267
1294
|
#
|
1268
1295
|
# @!attribute [rw] container_action
|
@@ -1321,8 +1348,8 @@ module Aws::IoTAnalytics
|
|
1321
1348
|
# }
|
1322
1349
|
#
|
1323
1350
|
# @!attribute [rw] iot_events_destination_configuration
|
1324
|
-
# Configuration information for delivery of dataset contents to
|
1325
|
-
#
|
1351
|
+
# Configuration information for delivery of dataset contents to IoT
|
1352
|
+
# Events.
|
1326
1353
|
# @return [Types::IotEventsDestinationConfiguration]
|
1327
1354
|
#
|
1328
1355
|
# @!attribute [rw] s3_destination_configuration
|
@@ -1377,16 +1404,16 @@ module Aws::IoTAnalytics
|
|
1377
1404
|
include Aws::Structure
|
1378
1405
|
end
|
1379
1406
|
|
1380
|
-
# The state of the
|
1407
|
+
# The state of the dataset contents and the reason they are in this
|
1381
1408
|
# state.
|
1382
1409
|
#
|
1383
1410
|
# @!attribute [rw] state
|
1384
|
-
# The state of the
|
1411
|
+
# The state of the dataset contents. Can be one of READY, CREATING,
|
1385
1412
|
# SUCCEEDED, or FAILED.
|
1386
1413
|
# @return [String]
|
1387
1414
|
#
|
1388
1415
|
# @!attribute [rw] reason
|
1389
|
-
# The reason the
|
1416
|
+
# The reason the dataset contents are in this state.
|
1390
1417
|
# @return [String]
|
1391
1418
|
#
|
1392
1419
|
class DatasetContentStatus < Struct.new(
|
@@ -1403,7 +1430,7 @@ module Aws::IoTAnalytics
|
|
1403
1430
|
# @return [String]
|
1404
1431
|
#
|
1405
1432
|
# @!attribute [rw] status
|
1406
|
-
# The status of the
|
1433
|
+
# The status of the dataset contents.
|
1407
1434
|
# @return [Types::DatasetContentStatus]
|
1408
1435
|
#
|
1409
1436
|
# @!attribute [rw] creation_time
|
@@ -1451,14 +1478,14 @@ module Aws::IoTAnalytics
|
|
1451
1478
|
include Aws::Structure
|
1452
1479
|
end
|
1453
1480
|
|
1454
|
-
# The reference to a
|
1481
|
+
# The reference to a dataset entry.
|
1455
1482
|
#
|
1456
1483
|
# @!attribute [rw] entry_name
|
1457
|
-
# The name of the
|
1484
|
+
# The name of the dataset item.
|
1458
1485
|
# @return [String]
|
1459
1486
|
#
|
1460
1487
|
# @!attribute [rw] data_uri
|
1461
|
-
# The presigned URI of the
|
1488
|
+
# The presigned URI of the dataset item.
|
1462
1489
|
# @return [String]
|
1463
1490
|
#
|
1464
1491
|
class DatasetEntry < Struct.new(
|
@@ -1468,28 +1495,28 @@ module Aws::IoTAnalytics
|
|
1468
1495
|
include Aws::Structure
|
1469
1496
|
end
|
1470
1497
|
|
1471
|
-
# A summary of information about a
|
1498
|
+
# A summary of information about a dataset.
|
1472
1499
|
#
|
1473
1500
|
# @!attribute [rw] dataset_name
|
1474
|
-
# The name of the
|
1501
|
+
# The name of the dataset.
|
1475
1502
|
# @return [String]
|
1476
1503
|
#
|
1477
1504
|
# @!attribute [rw] status
|
1478
|
-
# The status of the
|
1505
|
+
# The status of the dataset.
|
1479
1506
|
# @return [String]
|
1480
1507
|
#
|
1481
1508
|
# @!attribute [rw] creation_time
|
1482
|
-
# The time the
|
1509
|
+
# The time the dataset was created.
|
1483
1510
|
# @return [Time]
|
1484
1511
|
#
|
1485
1512
|
# @!attribute [rw] last_update_time
|
1486
|
-
# The last time the
|
1513
|
+
# The last time the dataset was updated.
|
1487
1514
|
# @return [Time]
|
1488
1515
|
#
|
1489
1516
|
# @!attribute [rw] triggers
|
1490
|
-
# A list of triggers. A trigger causes
|
1491
|
-
#
|
1492
|
-
#
|
1517
|
+
# A list of triggers. A trigger causes dataset content to be populated
|
1518
|
+
# at a specified time interval or when another dataset is populated.
|
1519
|
+
# The list of triggers can be empty or contain up to five
|
1493
1520
|
# `DataSetTrigger` objects
|
1494
1521
|
# @return [Array<Types::DatasetTrigger>]
|
1495
1522
|
#
|
@@ -1508,7 +1535,7 @@ module Aws::IoTAnalytics
|
|
1508
1535
|
include Aws::Structure
|
1509
1536
|
end
|
1510
1537
|
|
1511
|
-
# The `DatasetTrigger` that specifies when the
|
1538
|
+
# The `DatasetTrigger` that specifies when the dataset is automatically
|
1512
1539
|
# updated.
|
1513
1540
|
#
|
1514
1541
|
# @note When making an API call, you may pass DatasetTrigger
|
@@ -1528,8 +1555,8 @@ module Aws::IoTAnalytics
|
|
1528
1555
|
# @return [Types::Schedule]
|
1529
1556
|
#
|
1530
1557
|
# @!attribute [rw] dataset
|
1531
|
-
# The
|
1532
|
-
#
|
1558
|
+
# The dataset whose content creation triggers the creation of this
|
1559
|
+
# dataset's contents.
|
1533
1560
|
# @return [Types::TriggeringDataset]
|
1534
1561
|
#
|
1535
1562
|
class DatasetTrigger < Struct.new(
|
@@ -1546,10 +1573,11 @@ module Aws::IoTAnalytics
|
|
1546
1573
|
# @return [String]
|
1547
1574
|
#
|
1548
1575
|
# @!attribute [rw] storage
|
1549
|
-
# Where data
|
1550
|
-
# `serviceManagedS3`
|
1551
|
-
#
|
1552
|
-
#
|
1576
|
+
# Where data in a data store is stored.. You can choose
|
1577
|
+
# `serviceManagedS3` storage, `customerManagedS3` storage, or
|
1578
|
+
# `iotSiteWiseMultiLayerStorage` storage. The default is
|
1579
|
+
# `serviceManagedS3`. You can't change the choice of Amazon S3
|
1580
|
+
# storage after your data store is created.
|
1553
1581
|
# @return [Types::DatastoreStorage]
|
1554
1582
|
#
|
1555
1583
|
# @!attribute [rw] arn
|
@@ -1588,16 +1616,16 @@ module Aws::IoTAnalytics
|
|
1588
1616
|
# @!attribute [rw] last_message_arrival_time
|
1589
1617
|
# The last time when a new message arrived in the data store.
|
1590
1618
|
#
|
1591
|
-
#
|
1592
|
-
# data store. Hence, the
|
1593
|
-
# approximation.
|
1619
|
+
# IoT Analytics updates this value at most once per minute for Amazon
|
1620
|
+
# Simple Storage Service one data store. Hence, the
|
1621
|
+
# `lastMessageArrivalTime` value is an approximation.
|
1594
1622
|
#
|
1595
1623
|
# This feature only applies to messages that arrived in the data store
|
1596
1624
|
# after October 23, 2020.
|
1597
1625
|
# @return [Time]
|
1598
1626
|
#
|
1599
1627
|
# @!attribute [rw] file_format_configuration
|
1600
|
-
# Contains the configuration information of file formats.
|
1628
|
+
# Contains the configuration information of file formats. IoT
|
1601
1629
|
# Analytics data stores support JSON and [Parquet][1].
|
1602
1630
|
#
|
1603
1631
|
# The default file format is JSON. You can specify only one format.
|
@@ -1609,6 +1637,10 @@ module Aws::IoTAnalytics
|
|
1609
1637
|
# [1]: https://parquet.apache.org/
|
1610
1638
|
# @return [Types::FileFormatConfiguration]
|
1611
1639
|
#
|
1640
|
+
# @!attribute [rw] datastore_partitions
|
1641
|
+
# Contains information about the partition dimensions in a data store.
|
1642
|
+
# @return [Types::DatastorePartitions]
|
1643
|
+
#
|
1612
1644
|
class Datastore < Struct.new(
|
1613
1645
|
:name,
|
1614
1646
|
:storage,
|
@@ -1618,7 +1650,8 @@ module Aws::IoTAnalytics
|
|
1618
1650
|
:creation_time,
|
1619
1651
|
:last_update_time,
|
1620
1652
|
:last_message_arrival_time,
|
1621
|
-
:file_format_configuration
|
1653
|
+
:file_format_configuration,
|
1654
|
+
:datastore_partitions)
|
1622
1655
|
SENSITIVE = []
|
1623
1656
|
include Aws::Structure
|
1624
1657
|
end
|
@@ -1649,6 +1682,105 @@ module Aws::IoTAnalytics
|
|
1649
1682
|
include Aws::Structure
|
1650
1683
|
end
|
1651
1684
|
|
1685
|
+
# Used to store data used by IoT SiteWise in an Amazon S3 bucket that
|
1686
|
+
# you manage. You can't change the choice of Amazon S3 storage after
|
1687
|
+
# your data store is created.
|
1688
|
+
#
|
1689
|
+
# @note When making an API call, you may pass DatastoreIotSiteWiseMultiLayerStorage
|
1690
|
+
# data as a hash:
|
1691
|
+
#
|
1692
|
+
# {
|
1693
|
+
# customer_managed_s3_storage: { # required
|
1694
|
+
# bucket: "BucketName", # required
|
1695
|
+
# key_prefix: "S3KeyPrefix",
|
1696
|
+
# },
|
1697
|
+
# }
|
1698
|
+
#
|
1699
|
+
# @!attribute [rw] customer_managed_s3_storage
|
1700
|
+
# Used to store data used by IoT SiteWise in an Amazon S3 bucket that
|
1701
|
+
# you manage.
|
1702
|
+
# @return [Types::IotSiteWiseCustomerManagedDatastoreS3Storage]
|
1703
|
+
#
|
1704
|
+
class DatastoreIotSiteWiseMultiLayerStorage < Struct.new(
|
1705
|
+
:customer_managed_s3_storage)
|
1706
|
+
SENSITIVE = []
|
1707
|
+
include Aws::Structure
|
1708
|
+
end
|
1709
|
+
|
1710
|
+
# Contains information about the data store that you manage, which
|
1711
|
+
# stores data used by IoT SiteWise.
|
1712
|
+
#
|
1713
|
+
# @!attribute [rw] customer_managed_s3_storage
|
1714
|
+
# Used to store data used by IoT SiteWise in an Amazon S3 bucket that
|
1715
|
+
# you manage.
|
1716
|
+
# @return [Types::IotSiteWiseCustomerManagedDatastoreS3StorageSummary]
|
1717
|
+
#
|
1718
|
+
class DatastoreIotSiteWiseMultiLayerStorageSummary < Struct.new(
|
1719
|
+
:customer_managed_s3_storage)
|
1720
|
+
SENSITIVE = []
|
1721
|
+
include Aws::Structure
|
1722
|
+
end
|
1723
|
+
|
1724
|
+
# A single dimension to partition a data store. The dimension must be an
|
1725
|
+
# `AttributePartition` or a `TimestampPartition`.
|
1726
|
+
#
|
1727
|
+
# @note When making an API call, you may pass DatastorePartition
|
1728
|
+
# data as a hash:
|
1729
|
+
#
|
1730
|
+
# {
|
1731
|
+
# attribute_partition: {
|
1732
|
+
# attribute_name: "PartitionAttributeName", # required
|
1733
|
+
# },
|
1734
|
+
# timestamp_partition: {
|
1735
|
+
# attribute_name: "PartitionAttributeName", # required
|
1736
|
+
# timestamp_format: "TimestampFormat",
|
1737
|
+
# },
|
1738
|
+
# }
|
1739
|
+
#
|
1740
|
+
# @!attribute [rw] attribute_partition
|
1741
|
+
# A partition dimension defined by an `attributeName`.
|
1742
|
+
# @return [Types::Partition]
|
1743
|
+
#
|
1744
|
+
# @!attribute [rw] timestamp_partition
|
1745
|
+
# A partition dimension defined by a timestamp attribute.
|
1746
|
+
# @return [Types::TimestampPartition]
|
1747
|
+
#
|
1748
|
+
class DatastorePartition < Struct.new(
|
1749
|
+
:attribute_partition,
|
1750
|
+
:timestamp_partition)
|
1751
|
+
SENSITIVE = []
|
1752
|
+
include Aws::Structure
|
1753
|
+
end
|
1754
|
+
|
1755
|
+
# Contains information about the partition dimensions in a data store.
|
1756
|
+
#
|
1757
|
+
# @note When making an API call, you may pass DatastorePartitions
|
1758
|
+
# data as a hash:
|
1759
|
+
#
|
1760
|
+
# {
|
1761
|
+
# partitions: [
|
1762
|
+
# {
|
1763
|
+
# attribute_partition: {
|
1764
|
+
# attribute_name: "PartitionAttributeName", # required
|
1765
|
+
# },
|
1766
|
+
# timestamp_partition: {
|
1767
|
+
# attribute_name: "PartitionAttributeName", # required
|
1768
|
+
# timestamp_format: "TimestampFormat",
|
1769
|
+
# },
|
1770
|
+
# },
|
1771
|
+
# ],
|
1772
|
+
# }
|
1773
|
+
#
|
1774
|
+
# @!attribute [rw] partitions
|
1775
|
+
# A list of partition dimensions in a data store.
|
1776
|
+
# @return [Array<Types::DatastorePartition>]
|
1777
|
+
#
|
1778
|
+
class DatastorePartitions < Struct.new(
|
1779
|
+
:partitions)
|
1780
|
+
SENSITIVE = []
|
1781
|
+
include Aws::Structure
|
1782
|
+
end
|
1783
|
+
|
1652
1784
|
# Statistical information about the data store.
|
1653
1785
|
#
|
1654
1786
|
# @!attribute [rw] size
|
@@ -1661,10 +1793,11 @@ module Aws::IoTAnalytics
|
|
1661
1793
|
include Aws::Structure
|
1662
1794
|
end
|
1663
1795
|
|
1664
|
-
# Where data
|
1665
|
-
# `serviceManagedS3`
|
1666
|
-
#
|
1667
|
-
#
|
1796
|
+
# Where data in a data store is stored.. You can choose
|
1797
|
+
# `serviceManagedS3` storage, `customerManagedS3` storage, or
|
1798
|
+
# `iotSiteWiseMultiLayerStorage` storage. The default is
|
1799
|
+
# `serviceManagedS3`. You can't change the choice of Amazon S3 storage
|
1800
|
+
# after your data store is created.
|
1668
1801
|
#
|
1669
1802
|
# @note When making an API call, you may pass DatastoreStorage
|
1670
1803
|
# data as a hash:
|
@@ -1677,43 +1810,59 @@ module Aws::IoTAnalytics
|
|
1677
1810
|
# key_prefix: "S3KeyPrefix",
|
1678
1811
|
# role_arn: "RoleArn", # required
|
1679
1812
|
# },
|
1813
|
+
# iot_site_wise_multi_layer_storage: {
|
1814
|
+
# customer_managed_s3_storage: { # required
|
1815
|
+
# bucket: "BucketName", # required
|
1816
|
+
# key_prefix: "S3KeyPrefix",
|
1817
|
+
# },
|
1818
|
+
# },
|
1680
1819
|
# }
|
1681
1820
|
#
|
1682
1821
|
# @!attribute [rw] service_managed_s3
|
1683
|
-
#
|
1684
|
-
#
|
1685
|
-
#
|
1822
|
+
# Used to store data in an Amazon S3 bucket managed by IoT Analytics.
|
1823
|
+
# You can't change the choice of Amazon S3 storage after your data
|
1824
|
+
# store is created.
|
1686
1825
|
# @return [Types::ServiceManagedDatastoreS3Storage]
|
1687
1826
|
#
|
1688
1827
|
# @!attribute [rw] customer_managed_s3
|
1689
|
-
#
|
1690
|
-
#
|
1691
|
-
#
|
1692
|
-
# customer-managed S3 storage cannot be changed after creation of the
|
1693
|
-
# data store.
|
1828
|
+
# S3-customer-managed; When you choose customer-managed storage, the
|
1829
|
+
# `retentionPeriod` parameter is ignored. You can't change the choice
|
1830
|
+
# of Amazon S3 storage after your data store is created.
|
1694
1831
|
# @return [Types::CustomerManagedDatastoreS3Storage]
|
1695
1832
|
#
|
1833
|
+
# @!attribute [rw] iot_site_wise_multi_layer_storage
|
1834
|
+
# Used to store data used by IoT SiteWise in an Amazon S3 bucket that
|
1835
|
+
# you manage. You can't change the choice of Amazon S3 storage after
|
1836
|
+
# your data store is created.
|
1837
|
+
# @return [Types::DatastoreIotSiteWiseMultiLayerStorage]
|
1838
|
+
#
|
1696
1839
|
class DatastoreStorage < Struct.new(
|
1697
1840
|
:service_managed_s3,
|
1698
|
-
:customer_managed_s3
|
1841
|
+
:customer_managed_s3,
|
1842
|
+
:iot_site_wise_multi_layer_storage)
|
1699
1843
|
SENSITIVE = []
|
1700
1844
|
include Aws::Structure
|
1701
1845
|
end
|
1702
1846
|
|
1703
|
-
#
|
1847
|
+
# Contains information about your data store.
|
1704
1848
|
#
|
1705
1849
|
# @!attribute [rw] service_managed_s3
|
1706
|
-
# Used to store data
|
1707
|
-
# Analytics.
|
1850
|
+
# Used to store data in an Amazon S3 bucket managed by IoT Analytics.
|
1708
1851
|
# @return [Types::ServiceManagedDatastoreS3StorageSummary]
|
1709
1852
|
#
|
1710
1853
|
# @!attribute [rw] customer_managed_s3
|
1711
|
-
# Used to store data
|
1854
|
+
# Used to store data in an Amazon S3 bucket managed by IoT Analytics.
|
1712
1855
|
# @return [Types::CustomerManagedDatastoreS3StorageSummary]
|
1713
1856
|
#
|
1857
|
+
# @!attribute [rw] iot_site_wise_multi_layer_storage
|
1858
|
+
# Used to store data used by IoT SiteWise in an Amazon S3 bucket that
|
1859
|
+
# you manage.
|
1860
|
+
# @return [Types::DatastoreIotSiteWiseMultiLayerStorageSummary]
|
1861
|
+
#
|
1714
1862
|
class DatastoreStorageSummary < Struct.new(
|
1715
1863
|
:service_managed_s3,
|
1716
|
-
:customer_managed_s3
|
1864
|
+
:customer_managed_s3,
|
1865
|
+
:iot_site_wise_multi_layer_storage)
|
1717
1866
|
SENSITIVE = []
|
1718
1867
|
include Aws::Structure
|
1719
1868
|
end
|
@@ -1725,7 +1874,7 @@ module Aws::IoTAnalytics
|
|
1725
1874
|
# @return [String]
|
1726
1875
|
#
|
1727
1876
|
# @!attribute [rw] datastore_storage
|
1728
|
-
# Where data
|
1877
|
+
# Where data in a data store is stored.
|
1729
1878
|
# @return [Types::DatastoreStorageSummary]
|
1730
1879
|
#
|
1731
1880
|
# @!attribute [rw] status
|
@@ -1743,9 +1892,9 @@ module Aws::IoTAnalytics
|
|
1743
1892
|
# @!attribute [rw] last_message_arrival_time
|
1744
1893
|
# The last time when a new message arrived in the data store.
|
1745
1894
|
#
|
1746
|
-
#
|
1747
|
-
# data store. Hence, the
|
1748
|
-
# approximation.
|
1895
|
+
# IoT Analytics updates this value at most once per minute for Amazon
|
1896
|
+
# Simple Storage Service one data store. Hence, the
|
1897
|
+
# `lastMessageArrivalTime` value is an approximation.
|
1749
1898
|
#
|
1750
1899
|
# This feature only applies to messages that arrived in the data store
|
1751
1900
|
# after October 23, 2020.
|
@@ -1755,6 +1904,10 @@ module Aws::IoTAnalytics
|
|
1755
1904
|
# The file format of the data in the data store.
|
1756
1905
|
# @return [String]
|
1757
1906
|
#
|
1907
|
+
# @!attribute [rw] datastore_partitions
|
1908
|
+
# Contains information about the partition dimensions in a data store.
|
1909
|
+
# @return [Types::DatastorePartitions]
|
1910
|
+
#
|
1758
1911
|
class DatastoreSummary < Struct.new(
|
1759
1912
|
:datastore_name,
|
1760
1913
|
:datastore_storage,
|
@@ -1762,7 +1915,8 @@ module Aws::IoTAnalytics
|
|
1762
1915
|
:creation_time,
|
1763
1916
|
:last_update_time,
|
1764
1917
|
:last_message_arrival_time,
|
1765
|
-
:file_format_type
|
1918
|
+
:file_format_type,
|
1919
|
+
:datastore_partitions)
|
1766
1920
|
SENSITIVE = []
|
1767
1921
|
include Aws::Structure
|
1768
1922
|
end
|
@@ -1818,7 +1972,7 @@ module Aws::IoTAnalytics
|
|
1818
1972
|
# }
|
1819
1973
|
#
|
1820
1974
|
# @!attribute [rw] dataset_name
|
1821
|
-
# The name of the
|
1975
|
+
# The name of the dataset to delete.
|
1822
1976
|
# @return [String]
|
1823
1977
|
#
|
1824
1978
|
class DeleteDatasetRequest < Struct.new(
|
@@ -1904,7 +2058,7 @@ module Aws::IoTAnalytics
|
|
1904
2058
|
# [ `DeltaTime` ][1] specifies a time interval. You can use `DeltaTime`
|
1905
2059
|
# to create dataset contents with data that has arrived in the data
|
1906
2060
|
# store since the last execution. For an example of `DeltaTime`, see [
|
1907
|
-
# Creating a SQL dataset with a delta window (CLI)][2] in the *
|
2061
|
+
# Creating a SQL dataset with a delta window (CLI)][2] in the *IoT
|
1908
2062
|
# Analytics User Guide*.
|
1909
2063
|
#
|
1910
2064
|
#
|
@@ -1920,10 +2074,10 @@ module Aws::IoTAnalytics
|
|
1920
2074
|
# }
|
1921
2075
|
#
|
1922
2076
|
# @!attribute [rw] timeout_in_minutes
|
1923
|
-
# A time interval. You can use `timeoutInMinutes` so that
|
2077
|
+
# A time interval. You can use `timeoutInMinutes` so that IoT
|
1924
2078
|
# Analytics can batch up late data notifications that have been
|
1925
|
-
# generated since the last execution.
|
1926
|
-
#
|
2079
|
+
# generated since the last execution. IoT Analytics sends one batch of
|
2080
|
+
# notifications to Amazon CloudWatch Events at one time.
|
1927
2081
|
#
|
1928
2082
|
# For more information about how to write a timestamp expression, see
|
1929
2083
|
# [Date and Time Functions and Operators][1], in the *Presto 0.172
|
@@ -1954,7 +2108,7 @@ module Aws::IoTAnalytics
|
|
1954
2108
|
#
|
1955
2109
|
# @!attribute [rw] include_statistics
|
1956
2110
|
# If true, additional statistical information about the channel is
|
1957
|
-
# included in the response. This feature
|
2111
|
+
# included in the response. This feature can't be used with a channel
|
1958
2112
|
# whose S3 storage is customer-managed.
|
1959
2113
|
# @return [Boolean]
|
1960
2114
|
#
|
@@ -1989,7 +2143,7 @@ module Aws::IoTAnalytics
|
|
1989
2143
|
# }
|
1990
2144
|
#
|
1991
2145
|
# @!attribute [rw] dataset_name
|
1992
|
-
# The name of the
|
2146
|
+
# The name of the dataset whose information is retrieved.
|
1993
2147
|
# @return [String]
|
1994
2148
|
#
|
1995
2149
|
class DescribeDatasetRequest < Struct.new(
|
@@ -1999,7 +2153,7 @@ module Aws::IoTAnalytics
|
|
1999
2153
|
end
|
2000
2154
|
|
2001
2155
|
# @!attribute [rw] dataset
|
2002
|
-
# An object that contains information about the
|
2156
|
+
# An object that contains information about the dataset.
|
2003
2157
|
# @return [Types::Dataset]
|
2004
2158
|
#
|
2005
2159
|
class DescribeDatasetResponse < Struct.new(
|
@@ -2022,7 +2176,7 @@ module Aws::IoTAnalytics
|
|
2022
2176
|
#
|
2023
2177
|
# @!attribute [rw] include_statistics
|
2024
2178
|
# If true, additional statistical information about the data store is
|
2025
|
-
# included in the response. This feature
|
2179
|
+
# included in the response. This feature can't be used with a data
|
2026
2180
|
# store whose S3 storage is customer-managed.
|
2027
2181
|
# @return [Boolean]
|
2028
2182
|
#
|
@@ -2054,7 +2208,7 @@ module Aws::IoTAnalytics
|
|
2054
2208
|
class DescribeLoggingOptionsRequest < Aws::EmptyStructure; end
|
2055
2209
|
|
2056
2210
|
# @!attribute [rw] logging_options
|
2057
|
-
# The current settings of the
|
2211
|
+
# The current settings of the IoT Analytics logging options.
|
2058
2212
|
# @return [Types::LoggingOptions]
|
2059
2213
|
#
|
2060
2214
|
class DescribeLoggingOptionsResponse < Struct.new(
|
@@ -2090,7 +2244,7 @@ module Aws::IoTAnalytics
|
|
2090
2244
|
include Aws::Structure
|
2091
2245
|
end
|
2092
2246
|
|
2093
|
-
# An activity that adds data from the
|
2247
|
+
# An activity that adds data from the IoT device registry to your
|
2094
2248
|
# message.
|
2095
2249
|
#
|
2096
2250
|
# @note When making an API call, you may pass DeviceRegistryEnrichActivity
|
@@ -2136,8 +2290,8 @@ module Aws::IoTAnalytics
|
|
2136
2290
|
include Aws::Structure
|
2137
2291
|
end
|
2138
2292
|
|
2139
|
-
# An activity that adds information from the
|
2140
|
-
#
|
2293
|
+
# An activity that adds information from the IoT Device Shadow service
|
2294
|
+
# to a message.
|
2141
2295
|
#
|
2142
2296
|
# @note When making an API call, you may pass DeviceShadowEnrichActivity
|
2143
2297
|
# data as a hash:
|
@@ -2198,8 +2352,8 @@ module Aws::IoTAnalytics
|
|
2198
2352
|
include Aws::Structure
|
2199
2353
|
end
|
2200
2354
|
|
2201
|
-
# Contains the configuration information of file formats.
|
2202
|
-
#
|
2355
|
+
# Contains the configuration information of file formats. IoT Analytics
|
2356
|
+
# data stores support JSON and [Parquet][1].
|
2203
2357
|
#
|
2204
2358
|
# The default file format is JSON. You can specify only one format.
|
2205
2359
|
#
|
@@ -2284,14 +2438,14 @@ module Aws::IoTAnalytics
|
|
2284
2438
|
# }
|
2285
2439
|
#
|
2286
2440
|
# @!attribute [rw] dataset_name
|
2287
|
-
# The name of the
|
2441
|
+
# The name of the dataset whose contents are retrieved.
|
2288
2442
|
# @return [String]
|
2289
2443
|
#
|
2290
2444
|
# @!attribute [rw] version_id
|
2291
|
-
# The version of the
|
2445
|
+
# The version of the dataset whose contents are retrieved. You can
|
2292
2446
|
# also use the strings "$LATEST" or "$LATEST\_SUCCEEDED" to
|
2293
2447
|
# retrieve the contents of the latest or latest successfully completed
|
2294
|
-
#
|
2448
|
+
# dataset. If not specified, "$LATEST\_SUCCEEDED" is the default.
|
2295
2449
|
# @return [String]
|
2296
2450
|
#
|
2297
2451
|
class GetDatasetContentRequest < Struct.new(
|
@@ -2310,7 +2464,7 @@ module Aws::IoTAnalytics
|
|
2310
2464
|
# @return [Time]
|
2311
2465
|
#
|
2312
2466
|
# @!attribute [rw] status
|
2313
|
-
# The status of the
|
2467
|
+
# The status of the dataset content.
|
2314
2468
|
# @return [Types::DatasetContentStatus]
|
2315
2469
|
#
|
2316
2470
|
class GetDatasetContentResponse < Struct.new(
|
@@ -2321,8 +2475,8 @@ module Aws::IoTAnalytics
|
|
2321
2475
|
include Aws::Structure
|
2322
2476
|
end
|
2323
2477
|
|
2324
|
-
# Configuration information for coordination with
|
2325
|
-
#
|
2478
|
+
# Configuration information for coordination with Glue, a fully managed
|
2479
|
+
# extract, transform and load (ETL) service.
|
2326
2480
|
#
|
2327
2481
|
# @note When making an API call, you may pass GlueConfiguration
|
2328
2482
|
# data as a hash:
|
@@ -2333,15 +2487,15 @@ module Aws::IoTAnalytics
|
|
2333
2487
|
# }
|
2334
2488
|
#
|
2335
2489
|
# @!attribute [rw] table_name
|
2336
|
-
# The name of the table in your
|
2337
|
-
# perform the ETL operations. An
|
2490
|
+
# The name of the table in your Glue Data Catalog that is used to
|
2491
|
+
# perform the ETL operations. An Glue Data Catalog table contains
|
2338
2492
|
# partitioned data and descriptions of data sources and targets.
|
2339
2493
|
# @return [String]
|
2340
2494
|
#
|
2341
2495
|
# @!attribute [rw] database_name
|
2342
|
-
# The name of the database in your
|
2343
|
-
# table is located. An
|
2344
|
-
#
|
2496
|
+
# The name of the database in your Glue Data Catalog in which the
|
2497
|
+
# table is located. An Glue Data Catalog database contains metadata
|
2498
|
+
# tables.
|
2345
2499
|
# @return [String]
|
2346
2500
|
#
|
2347
2501
|
class GlueConfiguration < Struct.new(
|
@@ -2373,7 +2527,7 @@ module Aws::IoTAnalytics
|
|
2373
2527
|
include Aws::Structure
|
2374
2528
|
end
|
2375
2529
|
|
2376
|
-
# Configuration information for delivery of dataset contents to
|
2530
|
+
# Configuration information for delivery of dataset contents to IoT
|
2377
2531
|
# Events.
|
2378
2532
|
#
|
2379
2533
|
# @note When making an API call, you may pass IotEventsDestinationConfiguration
|
@@ -2385,13 +2539,13 @@ module Aws::IoTAnalytics
|
|
2385
2539
|
# }
|
2386
2540
|
#
|
2387
2541
|
# @!attribute [rw] input_name
|
2388
|
-
# The name of the
|
2542
|
+
# The name of the IoT Events input to which dataset contents are
|
2389
2543
|
# delivered.
|
2390
2544
|
# @return [String]
|
2391
2545
|
#
|
2392
2546
|
# @!attribute [rw] role_arn
|
2393
|
-
# The ARN of the role that grants
|
2394
|
-
#
|
2547
|
+
# The ARN of the role that grants IoT Analytics permission to deliver
|
2548
|
+
# dataset contents to an IoT Events input.
|
2395
2549
|
# @return [String]
|
2396
2550
|
#
|
2397
2551
|
class IotEventsDestinationConfiguration < Struct.new(
|
@@ -2401,6 +2555,57 @@ module Aws::IoTAnalytics
|
|
2401
2555
|
include Aws::Structure
|
2402
2556
|
end
|
2403
2557
|
|
2558
|
+
# Used to store data used by IoT SiteWise in an Amazon S3 bucket that
|
2559
|
+
# you manage. You can't change the choice of Amazon S3 storage after
|
2560
|
+
# your data store is created.
|
2561
|
+
#
|
2562
|
+
# @note When making an API call, you may pass IotSiteWiseCustomerManagedDatastoreS3Storage
|
2563
|
+
# data as a hash:
|
2564
|
+
#
|
2565
|
+
# {
|
2566
|
+
# bucket: "BucketName", # required
|
2567
|
+
# key_prefix: "S3KeyPrefix",
|
2568
|
+
# }
|
2569
|
+
#
|
2570
|
+
# @!attribute [rw] bucket
|
2571
|
+
# The name of the Amazon S3 bucket where your data is stored.
|
2572
|
+
# @return [String]
|
2573
|
+
#
|
2574
|
+
# @!attribute [rw] key_prefix
|
2575
|
+
# (Optional) The prefix used to create the keys of the data store data
|
2576
|
+
# objects. Each object in an Amazon S3 bucket has a key that is its
|
2577
|
+
# unique identifier in the bucket. Each object in a bucket has exactly
|
2578
|
+
# one key. The prefix must end with a forward slash (/).
|
2579
|
+
# @return [String]
|
2580
|
+
#
|
2581
|
+
class IotSiteWiseCustomerManagedDatastoreS3Storage < Struct.new(
|
2582
|
+
:bucket,
|
2583
|
+
:key_prefix)
|
2584
|
+
SENSITIVE = []
|
2585
|
+
include Aws::Structure
|
2586
|
+
end
|
2587
|
+
|
2588
|
+
# Contains information about the data store that you manage, which
|
2589
|
+
# stores data used by IoT SiteWise.
|
2590
|
+
#
|
2591
|
+
# @!attribute [rw] bucket
|
2592
|
+
# The name of the Amazon S3 bucket where your data is stored.
|
2593
|
+
# @return [String]
|
2594
|
+
#
|
2595
|
+
# @!attribute [rw] key_prefix
|
2596
|
+
# (Optional) The prefix used to create the keys of the data store data
|
2597
|
+
# objects. Each object in an Amazon S3 bucket has a key that is its
|
2598
|
+
# unique identifier in the bucket. Each object in a bucket has exactly
|
2599
|
+
# one key. The prefix must end with a forward slash (/).
|
2600
|
+
# @return [String]
|
2601
|
+
#
|
2602
|
+
class IotSiteWiseCustomerManagedDatastoreS3StorageSummary < Struct.new(
|
2603
|
+
:bucket,
|
2604
|
+
:key_prefix)
|
2605
|
+
SENSITIVE = []
|
2606
|
+
include Aws::Structure
|
2607
|
+
end
|
2608
|
+
|
2404
2609
|
# Contains the configuration information of the JSON format.
|
2405
2610
|
#
|
2406
2611
|
# @api private
|
@@ -2563,8 +2768,7 @@ module Aws::IoTAnalytics
|
|
2563
2768
|
# }
|
2564
2769
|
#
|
2565
2770
|
# @!attribute [rw] dataset_name
|
2566
|
-
# The name of the
|
2567
|
-
# list.
|
2771
|
+
# The name of the dataset whose contents information you want to list.
|
2568
2772
|
# @return [String]
|
2569
2773
|
#
|
2570
2774
|
# @!attribute [rw] next_token
|
@@ -2576,13 +2780,13 @@ module Aws::IoTAnalytics
|
|
2576
2780
|
# @return [Integer]
|
2577
2781
|
#
|
2578
2782
|
# @!attribute [rw] scheduled_on_or_after
|
2579
|
-
# A filter to limit results to those
|
2783
|
+
# A filter to limit results to those dataset contents whose creation
|
2580
2784
|
# is scheduled on or after the given time. See the field
|
2581
2785
|
# `triggers.schedule` in the `CreateDataset` request. (timestamp)
|
2582
2786
|
# @return [Time]
|
2583
2787
|
#
|
2584
2788
|
# @!attribute [rw] scheduled_before
|
2585
|
-
# A filter to limit results to those
|
2789
|
+
# A filter to limit results to those dataset contents whose creation
|
2586
2790
|
# is scheduled before the given time. See the field
|
2587
2791
|
# `triggers.schedule` in the `CreateDataset` request. (timestamp)
|
2588
2792
|
# @return [Time]
|
@@ -2598,7 +2802,7 @@ module Aws::IoTAnalytics
|
|
2598
2802
|
end
|
2599
2803
|
|
2600
2804
|
# @!attribute [rw] dataset_content_summaries
|
2601
|
-
# Summary information about
|
2805
|
+
# Summary information about dataset contents that have been created.
|
2602
2806
|
# @return [Array<Types::DatasetContentSummary>]
|
2603
2807
|
#
|
2604
2808
|
# @!attribute [rw] next_token
|
@@ -2775,7 +2979,7 @@ module Aws::IoTAnalytics
|
|
2775
2979
|
# }
|
2776
2980
|
#
|
2777
2981
|
# @!attribute [rw] role_arn
|
2778
|
-
# The ARN of the role that grants permission to
|
2982
|
+
# The ARN of the role that grants permission to IoT Analytics to
|
2779
2983
|
# perform logging.
|
2780
2984
|
# @return [String]
|
2781
2985
|
#
|
@@ -2784,7 +2988,7 @@ module Aws::IoTAnalytics
|
|
2784
2988
|
# @return [String]
|
2785
2989
|
#
|
2786
2990
|
# @!attribute [rw] enabled
|
2787
|
-
# If true, logging is enabled for
|
2991
|
+
# If true, logging is enabled for IoT Analytics.
|
2788
2992
|
# @return [Boolean]
|
2789
2993
|
#
|
2790
2994
|
class LoggingOptions < Struct.new(
|
@@ -2910,6 +3114,25 @@ module Aws::IoTAnalytics
|
|
2910
3114
|
include Aws::Structure
|
2911
3115
|
end
|
2912
3116
|
|
3117
|
+
# A partition dimension defined by an attribute.
|
3118
|
+
#
|
3119
|
+
# @note When making an API call, you may pass Partition
|
3120
|
+
# data as a hash:
|
3121
|
+
#
|
3122
|
+
# {
|
3123
|
+
# attribute_name: "PartitionAttributeName", # required
|
3124
|
+
# }
|
3125
|
+
#
|
3126
|
+
# @!attribute [rw] attribute_name
|
3127
|
+
# The name of the attribute that defines a partition dimension.
|
3128
|
+
# @return [String]
|
3129
|
+
#
|
3130
|
+
class Partition < Struct.new(
|
3131
|
+
:attribute_name)
|
3132
|
+
SENSITIVE = []
|
3133
|
+
include Aws::Structure
|
3134
|
+
end
|
3135
|
+
|
2913
3136
|
# Contains information about a pipeline.
|
2914
3137
|
#
|
2915
3138
|
# @!attribute [rw] name
|
@@ -3033,8 +3256,8 @@ module Aws::IoTAnalytics
|
|
3033
3256
|
# @return [Types::RemoveAttributesActivity]
|
3034
3257
|
#
|
3035
3258
|
# @!attribute [rw] select_attributes
|
3036
|
-
#
|
3037
|
-
# original message.
|
3259
|
+
# Used to create a new message using only the specified attributes
|
3260
|
+
# from the original message.
|
3038
3261
|
# @return [Types::SelectAttributesActivity]
|
3039
3262
|
#
|
3040
3263
|
# @!attribute [rw] filter
|
@@ -3047,12 +3270,11 @@ module Aws::IoTAnalytics
|
|
3047
3270
|
# @return [Types::MathActivity]
|
3048
3271
|
#
|
3049
3272
|
# @!attribute [rw] device_registry_enrich
|
3050
|
-
# Adds data from the
|
3273
|
+
# Adds data from the IoT device registry to your message.
|
3051
3274
|
# @return [Types::DeviceRegistryEnrichActivity]
|
3052
3275
|
#
|
3053
3276
|
# @!attribute [rw] device_shadow_enrich
|
3054
|
-
# Adds information from the
|
3055
|
-
# message.
|
3277
|
+
# Adds information from the IoT Device Shadow service to a message.
|
3056
3278
|
# @return [Types::DeviceShadowEnrichActivity]
|
3057
3279
|
#
|
3058
3280
|
class PipelineActivity < Struct.new(
|
@@ -3109,7 +3331,7 @@ module Aws::IoTAnalytics
|
|
3109
3331
|
# }
|
3110
3332
|
#
|
3111
3333
|
# @!attribute [rw] logging_options
|
3112
|
-
# The new values of the
|
3334
|
+
# The new values of the IoT Analytics logging options.
|
3113
3335
|
# @return [Types::LoggingOptions]
|
3114
3336
|
#
|
3115
3337
|
class PutLoggingOptionsRequest < Struct.new(
|
@@ -3350,9 +3572,9 @@ module Aws::IoTAnalytics
|
|
3350
3572
|
#
|
3351
3573
|
# @!attribute [rw] pipeline_activity
|
3352
3574
|
# The pipeline activity that is run. This must not be a channel
|
3353
|
-
# activity or a
|
3575
|
+
# activity or a data store activity because these activities are used
|
3354
3576
|
# in a pipeline only to load the original message and to store the
|
3355
|
-
# (possibly) transformed message. If a
|
3577
|
+
# (possibly) transformed message. If a Lambda activity is specified,
|
3356
3578
|
# only short-running Lambda functions (those with a timeout of less
|
3357
3579
|
# than 30 seconds or less) can be used.
|
3358
3580
|
# @return [Types::PipelineActivity]
|
@@ -3435,13 +3657,13 @@ module Aws::IoTAnalytics
|
|
3435
3657
|
# @return [String]
|
3436
3658
|
#
|
3437
3659
|
# @!attribute [rw] glue_configuration
|
3438
|
-
# Configuration information for coordination with
|
3660
|
+
# Configuration information for coordination with Glue, a fully
|
3439
3661
|
# managed extract, transform and load (ETL) service.
|
3440
3662
|
# @return [Types::GlueConfiguration]
|
3441
3663
|
#
|
3442
3664
|
# @!attribute [rw] role_arn
|
3443
|
-
# The ARN of the role that grants
|
3444
|
-
#
|
3665
|
+
# The ARN of the role that grants IoT Analytics permission to interact
|
3666
|
+
# with your Amazon S3 and Glue resources.
|
3445
3667
|
# @return [String]
|
3446
3668
|
#
|
3447
3669
|
class S3DestinationConfiguration < Struct.new(
|
@@ -3544,7 +3766,7 @@ module Aws::IoTAnalytics
|
|
3544
3766
|
# Specifies one or more columns that store your data.
|
3545
3767
|
#
|
3546
3768
|
# Each schema can have up to 100 columns. Each column can have up to
|
3547
|
-
# 100 nested types
|
3769
|
+
# 100 nested types.
|
3548
3770
|
# @return [Array<Types::Column>]
|
3549
3771
|
#
|
3550
3772
|
class SchemaDefinition < Struct.new(
|
@@ -3553,8 +3775,8 @@ module Aws::IoTAnalytics
|
|
3553
3775
|
include Aws::Structure
|
3554
3776
|
end
|
3555
3777
|
|
3556
|
-
#
|
3557
|
-
# original message.
|
3778
|
+
# Used to create a new message using only the specified attributes from
|
3779
|
+
# the original message.
|
3558
3780
|
#
|
3559
3781
|
# @note When making an API call, you may pass SelectAttributesActivity
|
3560
3782
|
# data as a hash:
|
@@ -3585,28 +3807,27 @@ module Aws::IoTAnalytics
|
|
3585
3807
|
include Aws::Structure
|
3586
3808
|
end
|
3587
3809
|
|
3588
|
-
#
|
3589
|
-
#
|
3590
|
-
#
|
3810
|
+
# Used to store channel data in an S3 bucket managed by IoT Analytics.
|
3811
|
+
# You can't change the choice of S3 storage after the data store is
|
3812
|
+
# created.
|
3591
3813
|
#
|
3592
3814
|
# @api private
|
3593
3815
|
#
|
3594
3816
|
class ServiceManagedChannelS3Storage < Aws::EmptyStructure; end
|
3595
3817
|
|
3596
|
-
# Used to store channel data in an S3 bucket managed by
|
3597
|
-
# Analytics.
|
3818
|
+
# Used to store channel data in an S3 bucket managed by IoT Analytics.
|
3598
3819
|
#
|
3599
3820
|
class ServiceManagedChannelS3StorageSummary < Aws::EmptyStructure; end
|
3600
3821
|
|
3601
|
-
#
|
3602
|
-
#
|
3603
|
-
#
|
3822
|
+
# Used to store data in an Amazon S3 bucket managed by IoT Analytics.
|
3823
|
+
# You can't change the choice of Amazon S3 storage after your data
|
3824
|
+
# store is created.
|
3604
3825
|
#
|
3605
3826
|
# @api private
|
3606
3827
|
#
|
3607
3828
|
class ServiceManagedDatastoreS3Storage < Aws::EmptyStructure; end
|
3608
3829
|
|
3609
|
-
#
|
3830
|
+
# Contains information about the data store that is managed by IoT
|
3610
3831
|
# Analytics.
|
3611
3832
|
#
|
3612
3833
|
class ServiceManagedDatastoreS3StorageSummary < Aws::EmptyStructure; end
|
@@ -3777,6 +3998,33 @@ module Aws::IoTAnalytics
|
|
3777
3998
|
include Aws::Structure
|
3778
3999
|
end
|
3779
4000
|
|
4001
|
+
# A partition dimension defined by a timestamp attribute.
|
4002
|
+
#
|
4003
|
+
# @note When making an API call, you may pass TimestampPartition
|
4004
|
+
# data as a hash:
|
4005
|
+
#
|
4006
|
+
# {
|
4007
|
+
# attribute_name: "PartitionAttributeName", # required
|
4008
|
+
# timestamp_format: "TimestampFormat",
|
4009
|
+
# }
|
4010
|
+
#
|
4011
|
+
# @!attribute [rw] attribute_name
|
4012
|
+
# The attribute name of the partition defined by a timestamp.
|
4013
|
+
# @return [String]
|
4014
|
+
#
|
4015
|
+
# @!attribute [rw] timestamp_format
|
4016
|
+
# The timestamp format of a partition defined by a timestamp. The
|
4017
|
+
# default format is seconds since epoch (January 1, 1970 at midnight
|
4018
|
+
# UTC time).
|
4019
|
+
# @return [String]
|
4020
|
+
#
|
4021
|
+
class TimestampPartition < Struct.new(
|
4022
|
+
:attribute_name,
|
4023
|
+
:timestamp_format)
|
4024
|
+
SENSITIVE = []
|
4025
|
+
include Aws::Structure
|
4026
|
+
end
|
4027
|
+
|
3780
4028
|
# Information about the dataset whose content generation triggers the
|
3781
4029
|
# new dataset content generation.
|
3782
4030
|
#
|
@@ -3850,14 +4098,14 @@ module Aws::IoTAnalytics
|
|
3850
4098
|
# @!attribute [rw] channel_storage
|
3851
4099
|
# Where channel data is stored. You can choose one of
|
3852
4100
|
# `serviceManagedS3` or `customerManagedS3` storage. If not specified,
|
3853
|
-
# the default is `serviceManagedS3`. You
|
4101
|
+
# the default is `serviceManagedS3`. You can't change this storage
|
3854
4102
|
# option after the channel is created.
|
3855
4103
|
# @return [Types::ChannelStorage]
|
3856
4104
|
#
|
3857
4105
|
# @!attribute [rw] retention_period
|
3858
4106
|
# How long, in days, message data is kept for the channel. The
|
3859
|
-
# retention period
|
3860
|
-
# customer-managed.
|
4107
|
+
# retention period can't be updated if the channel's Amazon S3
|
4108
|
+
# storage is customer-managed.
|
3861
4109
|
# @return [Types::RetentionPeriod]
|
3862
4110
|
#
|
3863
4111
|
class UpdateChannelRequest < Struct.new(
|
@@ -3961,7 +4209,7 @@ module Aws::IoTAnalytics
|
|
3961
4209
|
# }
|
3962
4210
|
#
|
3963
4211
|
# @!attribute [rw] dataset_name
|
3964
|
-
# The name of the
|
4212
|
+
# The name of the dataset to update.
|
3965
4213
|
# @return [String]
|
3966
4214
|
#
|
3967
4215
|
# @!attribute [rw] actions
|
@@ -3987,8 +4235,8 @@ module Aws::IoTAnalytics
|
|
3987
4235
|
# specified or set to null, only the latest version plus the latest
|
3988
4236
|
# succeeded version (if they are different) are kept for the time
|
3989
4237
|
# period specified by the `retentionPeriod` parameter. For more
|
3990
|
-
# information, see [Keeping Multiple Versions of
|
3991
|
-
#
|
4238
|
+
# information, see [Keeping Multiple Versions of IoT Analytics
|
4239
|
+
# datasets][1] in the *IoT Analytics User Guide*.
|
3992
4240
|
#
|
3993
4241
|
#
|
3994
4242
|
#
|
@@ -3996,9 +4244,9 @@ module Aws::IoTAnalytics
|
|
3996
4244
|
# @return [Types::VersioningConfiguration]
|
3997
4245
|
#
|
3998
4246
|
# @!attribute [rw] late_data_rules
|
3999
|
-
# A list of data rules that send notifications to
|
4000
|
-
#
|
4001
|
-
#
|
4247
|
+
# A list of data rules that send notifications to CloudWatch, when
|
4248
|
+
# data arrives late. To specify `lateDataRules`, the dataset must use
|
4249
|
+
# a [DeltaTimer][1] filter.
|
4002
4250
|
#
|
4003
4251
|
#
|
4004
4252
|
#
|
@@ -4034,6 +4282,12 @@ module Aws::IoTAnalytics
|
|
4034
4282
|
# key_prefix: "S3KeyPrefix",
|
4035
4283
|
# role_arn: "RoleArn", # required
|
4036
4284
|
# },
|
4285
|
+
# iot_site_wise_multi_layer_storage: {
|
4286
|
+
# customer_managed_s3_storage: { # required
|
4287
|
+
# bucket: "BucketName", # required
|
4288
|
+
# key_prefix: "S3KeyPrefix",
|
4289
|
+
# },
|
4290
|
+
# },
|
4037
4291
|
# },
|
4038
4292
|
# file_format_configuration: {
|
4039
4293
|
# json_configuration: {
|
@@ -4057,19 +4311,20 @@ module Aws::IoTAnalytics
|
|
4057
4311
|
#
|
4058
4312
|
# @!attribute [rw] retention_period
|
4059
4313
|
# How long, in days, message data is kept for the data store. The
|
4060
|
-
# retention period
|
4061
|
-
# is customer-managed.
|
4314
|
+
# retention period can't be updated if the data store's Amazon S3
|
4315
|
+
# storage is customer-managed.
|
4062
4316
|
# @return [Types::RetentionPeriod]
|
4063
4317
|
#
|
4064
4318
|
# @!attribute [rw] datastore_storage
|
4065
|
-
# Where data
|
4066
|
-
# `serviceManagedS3`
|
4067
|
-
#
|
4068
|
-
#
|
4319
|
+
# Where data in a data store is stored.. You can choose
|
4320
|
+
# `serviceManagedS3` storage, `customerManagedS3` storage, or
|
4321
|
+
# `iotSiteWiseMultiLayerStorage` storage. The default is
|
4322
|
+
# `serviceManagedS3`. You can't change the choice of Amazon S3
|
4323
|
+
# storage after your data store is created.
|
4069
4324
|
# @return [Types::DatastoreStorage]
|
4070
4325
|
#
|
4071
4326
|
# @!attribute [rw] file_format_configuration
|
4072
|
-
# Contains the configuration information of file formats.
|
4327
|
+
# Contains the configuration information of file formats. IoT
|
4073
4328
|
# Analytics data stores support JSON and [Parquet][1].
|
4074
4329
|
#
|
4075
4330
|
# The default file format is JSON. You can specify only one format.
|