aws-sdk-iotanalytics 1.34.0 → 1.35.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/aws-sdk-iotanalytics.rb +1 -1
- data/lib/aws-sdk-iotanalytics/client.rb +155 -89
- data/lib/aws-sdk-iotanalytics/client_api.rb +26 -0
- data/lib/aws-sdk-iotanalytics/types.rb +541 -316
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: b32118409bf9fe523e30881b211f7b36cd8958e3eafb6bc2f52811ac48b0ea5f
|
4
|
+
data.tar.gz: 19da51cfe7b8ca4a6422228d177b12176e9ddd34970ecc3f59a14cfcca126f04
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: ac3f9576e3ed9cafb5422941f454aa5f0f118bd461315cfe3109d16947dd4a70e05be56e48762b7b3200d9742e08173a8d9b84f28db00a9e0c99eab11a47c177
|
7
|
+
data.tar.gz: ac8ee07233d763bdd8c0bfc3c25675b8cfac28f517fe36b6367d13339a0027177b737ef2b4373e3c70635bfa5aa4623557783c96217217069d0d3a7c123ac201
|
data/lib/aws-sdk-iotanalytics.rb
CHANGED
@@ -333,13 +333,13 @@ module Aws::IoTAnalytics
|
|
333
333
|
# The name of the channel where the messages are sent.
|
334
334
|
#
|
335
335
|
# @option params [required, Array<Types::Message>] :messages
|
336
|
-
# The list of messages to be sent. Each message has format:
|
337
|
-
# "messageId": "string", "payload": "string"\\}
|
336
|
+
# The list of messages to be sent. Each message has the format: \\\{
|
337
|
+
# "messageId": "string", "payload": "string"\\}.
|
338
338
|
#
|
339
|
-
#
|
340
|
-
#
|
339
|
+
# The field names of message payloads (data) that you send to AWS IoT
|
340
|
+
# Analytics:
|
341
341
|
#
|
342
|
-
# * Must contain only alphanumeric characters and undescores (\_)
|
342
|
+
# * Must contain only alphanumeric characters and undescores (\_). No
|
343
343
|
# other special characters are allowed.
|
344
344
|
#
|
345
345
|
# * Must begin with an alphabetic character or single underscore (\_).
|
@@ -349,10 +349,10 @@ module Aws::IoTAnalytics
|
|
349
349
|
# * In regular expression terms:
|
350
350
|
# "^\[A-Za-z\_\](\[A-Za-z0-9\]*\|\[A-Za-z0-9\]\[A-Za-z0-9\_\]*)$".
|
351
351
|
#
|
352
|
-
# * Cannot be
|
352
|
+
# * Cannot be more than 255 characters.
|
353
353
|
#
|
354
|
-
# * Are case
|
355
|
-
#
|
354
|
+
# * Are case insensitive. (Fields named foo and FOO in the same payload
|
355
|
+
# are considered duplicates.)
|
356
356
|
#
|
357
357
|
# For example, \\\{"temp\_01": 29\\} or \\\{"\_temp\_01": 29\\} are
|
358
358
|
# valid, but \\\{"temp-01": 29\\}, \\\{"01\_temp": 29\\} or
|
@@ -395,7 +395,7 @@ module Aws::IoTAnalytics
|
|
395
395
|
#
|
396
396
|
# @option params [required, String] :reprocessing_id
|
397
397
|
# The ID of the reprocessing task (returned by
|
398
|
-
#
|
398
|
+
# `StartPipelineReprocessing`).
|
399
399
|
#
|
400
400
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
401
401
|
#
|
@@ -421,14 +421,14 @@ module Aws::IoTAnalytics
|
|
421
421
|
# The name of the channel.
|
422
422
|
#
|
423
423
|
# @option params [Types::ChannelStorage] :channel_storage
|
424
|
-
# Where channel data is stored. You
|
425
|
-
#
|
426
|
-
#
|
427
|
-
#
|
424
|
+
# Where channel data is stored. You can choose one of `serviceManagedS3`
|
425
|
+
# or `customerManagedS3` storage. If not specified, the default is
|
426
|
+
# `serviceManagedS3`. You cannot change this storage option after the
|
427
|
+
# channel is created.
|
428
428
|
#
|
429
429
|
# @option params [Types::RetentionPeriod] :retention_period
|
430
430
|
# How long, in days, message data is kept for the channel. When
|
431
|
-
#
|
431
|
+
# `customerManagedS3` storage is selected, this parameter is ignored.
|
432
432
|
#
|
433
433
|
# @option params [Array<Types::Tag>] :tags
|
434
434
|
# Metadata which can be used to manage the channel.
|
@@ -478,12 +478,12 @@ module Aws::IoTAnalytics
|
|
478
478
|
req.send_request(options)
|
479
479
|
end
|
480
480
|
|
481
|
-
# Creates a
|
482
|
-
# by applying a
|
481
|
+
# Creates a dataset. A dataset stores data retrieved from a data store
|
482
|
+
# by applying a `queryAction` (a SQL query) or a `containerAction`
|
483
483
|
# (executing a containerized application). This operation creates the
|
484
|
-
# skeleton of a
|
485
|
-
# calling
|
486
|
-
#
|
484
|
+
# skeleton of a dataset. The dataset can be populated manually by
|
485
|
+
# calling `CreateDatasetContent` or automatically according to a trigger
|
486
|
+
# you specify.
|
487
487
|
#
|
488
488
|
# @option params [required, String] :dataset_name
|
489
489
|
# The name of the data set.
|
@@ -495,31 +495,49 @@ module Aws::IoTAnalytics
|
|
495
495
|
# A list of triggers. A trigger causes data set contents to be populated
|
496
496
|
# at a specified time interval or when another data set's contents are
|
497
497
|
# created. The list of triggers can be empty or contain up to five
|
498
|
-
#
|
498
|
+
# `DataSetTrigger` objects.
|
499
499
|
#
|
500
500
|
# @option params [Array<Types::DatasetContentDeliveryRule>] :content_delivery_rules
|
501
|
-
# When
|
501
|
+
# When dataset contents are created, they are delivered to destinations
|
502
502
|
# specified here.
|
503
503
|
#
|
504
504
|
# @option params [Types::RetentionPeriod] :retention_period
|
505
|
-
#
|
506
|
-
#
|
507
|
-
#
|
508
|
-
#
|
509
|
-
# `versioningConfiguration` parameter.
|
510
|
-
#
|
505
|
+
# Optional. How long, in days, versions of dataset contents are kept for
|
506
|
+
# the dataset. If not specified or set to `null`, versions of dataset
|
507
|
+
# contents are retained for at most 90 days. The number of versions of
|
508
|
+
# dataset contents retained is determined by the
|
509
|
+
# `versioningConfiguration` parameter. For more information, see
|
510
|
+
# [Keeping Multiple Versions of AWS IoT Analytics Data Sets][1] in the
|
511
|
+
# *AWS IoT Analytics User Guide*.
|
512
|
+
#
|
513
|
+
#
|
514
|
+
#
|
515
|
+
# [1]: https://docs.aws.amazon.com/iotanalytics/latest/userguide/getting-started.html#aws-iot-analytics-dataset-versions
|
511
516
|
#
|
512
517
|
# @option params [Types::VersioningConfiguration] :versioning_configuration
|
513
|
-
#
|
518
|
+
# Optional. How many versions of dataset contents are kept. If not
|
514
519
|
# specified or set to null, only the latest version plus the latest
|
515
520
|
# succeeded version (if they are different) are kept for the time period
|
516
|
-
# specified by the
|
517
|
-
# see
|
518
|
-
#
|
521
|
+
# specified by the `retentionPeriod` parameter. For more information,
|
522
|
+
# see [Keeping Multiple Versions of AWS IoT Analytics Data Sets][1] in
|
523
|
+
# the *AWS IoT Analytics User Guide*.
|
524
|
+
#
|
525
|
+
#
|
526
|
+
#
|
527
|
+
# [1]: https://docs.aws.amazon.com/iotanalytics/latest/userguide/getting-started.html#aws-iot-analytics-dataset-versions
|
519
528
|
#
|
520
529
|
# @option params [Array<Types::Tag>] :tags
|
521
530
|
# Metadata which can be used to manage the data set.
|
522
531
|
#
|
532
|
+
# @option params [Array<Types::LateDataRule>] :late_data_rules
|
533
|
+
# A list of data rules that send notifications to Amazon CloudWatch,
|
534
|
+
# when data arrives late. To specify `lateDataRules`, the dataset must
|
535
|
+
# use a [DeltaTimer][1] filter.
|
536
|
+
#
|
537
|
+
#
|
538
|
+
#
|
539
|
+
# [1]: https://docs.aws.amazon.com/iotanalytics/latest/APIReference/API_DeltaTime.html
|
540
|
+
#
|
523
541
|
# @return [Types::CreateDatasetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
524
542
|
#
|
525
543
|
# * {Types::CreateDatasetResponse#dataset_name #dataset_name} => String
|
@@ -611,6 +629,16 @@ module Aws::IoTAnalytics
|
|
611
629
|
# value: "TagValue", # required
|
612
630
|
# },
|
613
631
|
# ],
|
632
|
+
# late_data_rules: [
|
633
|
+
# {
|
634
|
+
# rule_name: "LateDataRuleName",
|
635
|
+
# rule_configuration: { # required
|
636
|
+
# delta_time_session_window_configuration: {
|
637
|
+
# timeout_in_minutes: 1, # required
|
638
|
+
# },
|
639
|
+
# },
|
640
|
+
# },
|
641
|
+
# ],
|
614
642
|
# })
|
615
643
|
#
|
616
644
|
# @example Response structure
|
@@ -627,12 +655,19 @@ module Aws::IoTAnalytics
|
|
627
655
|
req.send_request(options)
|
628
656
|
end
|
629
657
|
|
630
|
-
# Creates the content of a data set by applying a
|
631
|
-
# query) or a
|
632
|
-
# application).
|
658
|
+
# Creates the content of a data set by applying a `queryAction` (a SQL
|
659
|
+
# query) or a `containerAction` (executing a containerized application).
|
633
660
|
#
|
634
661
|
# @option params [required, String] :dataset_name
|
635
|
-
# The name of the
|
662
|
+
# The name of the dataset.
|
663
|
+
#
|
664
|
+
# @option params [String] :version_id
|
665
|
+
# The version ID of the dataset content. To specify `versionId` for a
|
666
|
+
# dataset content, the dataset must use a [DeltaTimer][1] filter.
|
667
|
+
#
|
668
|
+
#
|
669
|
+
#
|
670
|
+
# [1]: https://docs.aws.amazon.com/iotanalytics/latest/APIReference/API_DeltaTime.html
|
636
671
|
#
|
637
672
|
# @return [Types::CreateDatasetContentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
638
673
|
#
|
@@ -642,6 +677,7 @@ module Aws::IoTAnalytics
|
|
642
677
|
#
|
643
678
|
# resp = client.create_dataset_content({
|
644
679
|
# dataset_name: "DatasetName", # required
|
680
|
+
# version_id: "DatasetContentVersion",
|
645
681
|
# })
|
646
682
|
#
|
647
683
|
# @example Response structure
|
@@ -661,14 +697,14 @@ module Aws::IoTAnalytics
|
|
661
697
|
# The name of the data store.
|
662
698
|
#
|
663
699
|
# @option params [Types::DatastoreStorage] :datastore_storage
|
664
|
-
# Where data store data is stored. You
|
665
|
-
#
|
666
|
-
#
|
667
|
-
# after the data store is created.
|
700
|
+
# Where data store data is stored. You can choose one of
|
701
|
+
# `serviceManagedS3` or `customerManagedS3` storage. If not specified,
|
702
|
+
# the default is `serviceManagedS3`. You cannot change this storage
|
703
|
+
# option after the data store is created.
|
668
704
|
#
|
669
705
|
# @option params [Types::RetentionPeriod] :retention_period
|
670
706
|
# How long, in days, message data is kept for the data store. When
|
671
|
-
#
|
707
|
+
# `customerManagedS3` storage is selected, this parameter is ignored.
|
672
708
|
#
|
673
709
|
# @option params [Array<Types::Tag>] :tags
|
674
710
|
# Metadata which can be used to manage the data store.
|
@@ -728,15 +764,15 @@ module Aws::IoTAnalytics
|
|
728
764
|
# The name of the pipeline.
|
729
765
|
#
|
730
766
|
# @option params [required, Array<Types::PipelineActivity>] :pipeline_activities
|
731
|
-
# A list of
|
767
|
+
# A list of `PipelineActivity` objects. Activities perform
|
732
768
|
# transformations on your messages, such as removing, renaming or adding
|
733
769
|
# message attributes; filtering messages based on attribute values;
|
734
770
|
# invoking your Lambda functions on messages for advanced processing; or
|
735
771
|
# performing mathematical transformations to normalize device data.
|
736
772
|
#
|
737
|
-
# The list can be 2-25
|
738
|
-
#
|
739
|
-
#
|
773
|
+
# The list can be 2-25 `PipelineActivity` objects and must contain both
|
774
|
+
# a `channel` and a `datastore` activity. Each entry in the list must
|
775
|
+
# contain only one activity. For example:
|
740
776
|
#
|
741
777
|
# `pipelineActivities = [ \{ "channel": \{ ... \} \}, \{ "lambda": \{
|
742
778
|
# ... \} \}, ... ]`
|
@@ -854,9 +890,9 @@ module Aws::IoTAnalytics
|
|
854
890
|
req.send_request(options)
|
855
891
|
end
|
856
892
|
|
857
|
-
# Deletes the specified
|
893
|
+
# Deletes the specified dataset.
|
858
894
|
#
|
859
|
-
# You do not have to delete the content of the
|
895
|
+
# You do not have to delete the content of the dataset before you
|
860
896
|
# perform this operation.
|
861
897
|
#
|
862
898
|
# @option params [required, String] :dataset_name
|
@@ -877,13 +913,13 @@ module Aws::IoTAnalytics
|
|
877
913
|
req.send_request(options)
|
878
914
|
end
|
879
915
|
|
880
|
-
# Deletes the content of the specified
|
916
|
+
# Deletes the content of the specified dataset.
|
881
917
|
#
|
882
918
|
# @option params [required, String] :dataset_name
|
883
|
-
# The name of the
|
919
|
+
# The name of the dataset whose content is deleted.
|
884
920
|
#
|
885
921
|
# @option params [String] :version_id
|
886
|
-
# The version of the
|
922
|
+
# The version of the dataset whose content is deleted. You can also use
|
887
923
|
# the strings "$LATEST" or "$LATEST\_SUCCEEDED" to delete the latest
|
888
924
|
# or latest successfully completed data set. If not specified,
|
889
925
|
# "$LATEST\_SUCCEEDED" is the default.
|
@@ -978,6 +1014,7 @@ module Aws::IoTAnalytics
|
|
978
1014
|
# resp.channel.retention_period.number_of_days #=> Integer
|
979
1015
|
# resp.channel.creation_time #=> Time
|
980
1016
|
# resp.channel.last_update_time #=> Time
|
1017
|
+
# resp.channel.last_message_arrival_time #=> Time
|
981
1018
|
# resp.statistics.size.estimated_size_in_bytes #=> Float
|
982
1019
|
# resp.statistics.size.estimated_on #=> Time
|
983
1020
|
#
|
@@ -988,7 +1025,7 @@ module Aws::IoTAnalytics
|
|
988
1025
|
req.send_request(options)
|
989
1026
|
end
|
990
1027
|
|
991
|
-
# Retrieves information about a
|
1028
|
+
# Retrieves information about a dataset.
|
992
1029
|
#
|
993
1030
|
# @option params [required, String] :dataset_name
|
994
1031
|
# The name of the data set whose information is retrieved.
|
@@ -1042,6 +1079,9 @@ module Aws::IoTAnalytics
|
|
1042
1079
|
# resp.dataset.retention_period.number_of_days #=> Integer
|
1043
1080
|
# resp.dataset.versioning_configuration.unlimited #=> Boolean
|
1044
1081
|
# resp.dataset.versioning_configuration.max_versions #=> Integer
|
1082
|
+
# resp.dataset.late_data_rules #=> Array
|
1083
|
+
# resp.dataset.late_data_rules[0].rule_name #=> String
|
1084
|
+
# resp.dataset.late_data_rules[0].rule_configuration.delta_time_session_window_configuration.timeout_in_minutes #=> Integer
|
1045
1085
|
#
|
1046
1086
|
# @overload describe_dataset(params = {})
|
1047
1087
|
# @param [Hash] params ({})
|
@@ -1084,6 +1124,7 @@ module Aws::IoTAnalytics
|
|
1084
1124
|
# resp.datastore.retention_period.number_of_days #=> Integer
|
1085
1125
|
# resp.datastore.creation_time #=> Time
|
1086
1126
|
# resp.datastore.last_update_time #=> Time
|
1127
|
+
# resp.datastore.last_message_arrival_time #=> Time
|
1087
1128
|
# resp.statistics.size.estimated_size_in_bytes #=> Float
|
1088
1129
|
# resp.statistics.size.estimated_on #=> Time
|
1089
1130
|
#
|
@@ -1186,7 +1227,7 @@ module Aws::IoTAnalytics
|
|
1186
1227
|
req.send_request(options)
|
1187
1228
|
end
|
1188
1229
|
|
1189
|
-
# Retrieves the contents of a data set as
|
1230
|
+
# Retrieves the contents of a data set as presigned URIs.
|
1190
1231
|
#
|
1191
1232
|
# @option params [required, String] :dataset_name
|
1192
1233
|
# The name of the data set whose contents are retrieved.
|
@@ -1260,6 +1301,7 @@ module Aws::IoTAnalytics
|
|
1260
1301
|
# resp.channel_summaries[0].status #=> String, one of "CREATING", "ACTIVE", "DELETING"
|
1261
1302
|
# resp.channel_summaries[0].creation_time #=> Time
|
1262
1303
|
# resp.channel_summaries[0].last_update_time #=> Time
|
1304
|
+
# resp.channel_summaries[0].last_message_arrival_time #=> Time
|
1263
1305
|
# resp.next_token #=> String
|
1264
1306
|
#
|
1265
1307
|
# @overload list_channels(params = {})
|
@@ -1283,12 +1325,12 @@ module Aws::IoTAnalytics
|
|
1283
1325
|
# @option params [Time,DateTime,Date,Integer,String] :scheduled_on_or_after
|
1284
1326
|
# A filter to limit results to those data set contents whose creation is
|
1285
1327
|
# scheduled on or after the given time. See the field
|
1286
|
-
# `triggers.schedule` in the CreateDataset request. (timestamp)
|
1328
|
+
# `triggers.schedule` in the `CreateDataset` request. (timestamp)
|
1287
1329
|
#
|
1288
1330
|
# @option params [Time,DateTime,Date,Integer,String] :scheduled_before
|
1289
1331
|
# A filter to limit results to those data set contents whose creation is
|
1290
1332
|
# scheduled before the given time. See the field `triggers.schedule` in
|
1291
|
-
# the CreateDataset request. (timestamp)
|
1333
|
+
# the `CreateDataset` request. (timestamp)
|
1292
1334
|
#
|
1293
1335
|
# @return [Types::ListDatasetContentsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1294
1336
|
#
|
@@ -1405,6 +1447,7 @@ module Aws::IoTAnalytics
|
|
1405
1447
|
# resp.datastore_summaries[0].status #=> String, one of "CREATING", "ACTIVE", "DELETING"
|
1406
1448
|
# resp.datastore_summaries[0].creation_time #=> Time
|
1407
1449
|
# resp.datastore_summaries[0].last_update_time #=> Time
|
1450
|
+
# resp.datastore_summaries[0].last_message_arrival_time #=> Time
|
1408
1451
|
# resp.next_token #=> String
|
1409
1452
|
#
|
1410
1453
|
# @overload list_datastores(params = {})
|
@@ -1457,7 +1500,7 @@ module Aws::IoTAnalytics
|
|
1457
1500
|
req.send_request(options)
|
1458
1501
|
end
|
1459
1502
|
|
1460
|
-
# Lists the tags (metadata)
|
1503
|
+
# Lists the tags (metadata) that you have assigned to the resource.
|
1461
1504
|
#
|
1462
1505
|
# @option params [required, String] :resource_arn
|
1463
1506
|
# The ARN of the resource whose tags you want to list.
|
@@ -1487,11 +1530,11 @@ module Aws::IoTAnalytics
|
|
1487
1530
|
|
1488
1531
|
# Sets or updates the AWS IoT Analytics logging options.
|
1489
1532
|
#
|
1490
|
-
#
|
1491
|
-
#
|
1492
|
-
#
|
1493
|
-
#
|
1494
|
-
#
|
1533
|
+
# If you update the value of any `loggingOptions` field, it takes up to
|
1534
|
+
# one minute for the change to take effect. Also, if you change the
|
1535
|
+
# policy attached to the role you specified in the `roleArn` field (for
|
1536
|
+
# example, to correct an invalid policy), it takes up to five minutes
|
1537
|
+
# for that change to take effect.
|
1495
1538
|
#
|
1496
1539
|
# @option params [required, Types::LoggingOptions] :logging_options
|
1497
1540
|
# The new values of the AWS IoT Analytics logging options.
|
@@ -1519,12 +1562,12 @@ module Aws::IoTAnalytics
|
|
1519
1562
|
# payload.
|
1520
1563
|
#
|
1521
1564
|
# @option params [required, Types::PipelineActivity] :pipeline_activity
|
1522
|
-
# The pipeline activity that is run. This must not be a
|
1523
|
-
#
|
1524
|
-
#
|
1525
|
-
#
|
1526
|
-
#
|
1527
|
-
#
|
1565
|
+
# The pipeline activity that is run. This must not be a channel activity
|
1566
|
+
# or a datastore activity because these activities are used in a
|
1567
|
+
# pipeline only to load the original message and to store the (possibly)
|
1568
|
+
# transformed message. If a lambda activity is specified, only
|
1569
|
+
# short-running Lambda functions (those with a timeout of less than 30
|
1570
|
+
# seconds or less) can be used.
|
1528
1571
|
#
|
1529
1572
|
# @option params [required, Array<String, StringIO, File>] :payloads
|
1530
1573
|
# The sample message payloads on which the pipeline activity is run.
|
@@ -1619,7 +1662,7 @@ module Aws::IoTAnalytics
|
|
1619
1662
|
# The name of the channel whose message samples are retrieved.
|
1620
1663
|
#
|
1621
1664
|
# @option params [Integer] :max_messages
|
1622
|
-
# The number of sample messages to be retrieved. The limit is 10
|
1665
|
+
# The number of sample messages to be retrieved. The limit is 10. The
|
1623
1666
|
# default is also 10.
|
1624
1667
|
#
|
1625
1668
|
# @option params [Time,DateTime,Date,Integer,String] :start_time
|
@@ -1688,7 +1731,7 @@ module Aws::IoTAnalytics
|
|
1688
1731
|
end
|
1689
1732
|
|
1690
1733
|
# Adds to or modifies the tags of the given resource. Tags are metadata
|
1691
|
-
#
|
1734
|
+
# that can be used to manage a resource.
|
1692
1735
|
#
|
1693
1736
|
# @option params [required, String] :resource_arn
|
1694
1737
|
# The ARN of the resource whose tags you want to modify.
|
@@ -1747,10 +1790,10 @@ module Aws::IoTAnalytics
|
|
1747
1790
|
# The name of the channel to be updated.
|
1748
1791
|
#
|
1749
1792
|
# @option params [Types::ChannelStorage] :channel_storage
|
1750
|
-
# Where channel data is stored. You
|
1751
|
-
#
|
1752
|
-
#
|
1753
|
-
#
|
1793
|
+
# Where channel data is stored. You can choose one of `serviceManagedS3`
|
1794
|
+
# or `customerManagedS3` storage. If not specified, the default is
|
1795
|
+
# `serviceManagedS3`. You cannot change this storage option after the
|
1796
|
+
# channel is created.
|
1754
1797
|
#
|
1755
1798
|
# @option params [Types::RetentionPeriod] :retention_period
|
1756
1799
|
# How long, in days, message data is kept for the channel. The retention
|
@@ -1791,26 +1834,39 @@ module Aws::IoTAnalytics
|
|
1791
1834
|
# The name of the data set to update.
|
1792
1835
|
#
|
1793
1836
|
# @option params [required, Array<Types::DatasetAction>] :actions
|
1794
|
-
# A list of
|
1837
|
+
# A list of `DatasetAction` objects.
|
1795
1838
|
#
|
1796
1839
|
# @option params [Array<Types::DatasetTrigger>] :triggers
|
1797
|
-
# A list of
|
1798
|
-
# contain up to five
|
1840
|
+
# A list of `DatasetTrigger` objects. The list can be empty or can
|
1841
|
+
# contain up to five `DatasetTrigger` objects.
|
1799
1842
|
#
|
1800
1843
|
# @option params [Array<Types::DatasetContentDeliveryRule>] :content_delivery_rules
|
1801
|
-
# When
|
1844
|
+
# When dataset contents are created, they are delivered to destinations
|
1802
1845
|
# specified here.
|
1803
1846
|
#
|
1804
1847
|
# @option params [Types::RetentionPeriod] :retention_period
|
1805
|
-
# How long, in days,
|
1848
|
+
# How long, in days, dataset contents are kept for the dataset.
|
1806
1849
|
#
|
1807
1850
|
# @option params [Types::VersioningConfiguration] :versioning_configuration
|
1808
|
-
#
|
1851
|
+
# Optional. How many versions of dataset contents are kept. If not
|
1809
1852
|
# specified or set to null, only the latest version plus the latest
|
1810
1853
|
# succeeded version (if they are different) are kept for the time period
|
1811
|
-
# specified by the
|
1812
|
-
# see
|
1813
|
-
#
|
1854
|
+
# specified by the `retentionPeriod` parameter. For more information,
|
1855
|
+
# see [Keeping Multiple Versions of AWS IoT Analytics Data Sets][1] in
|
1856
|
+
# the *AWS IoT Analytics User Guide*.
|
1857
|
+
#
|
1858
|
+
#
|
1859
|
+
#
|
1860
|
+
# [1]: https://docs.aws.amazon.com/iotanalytics/latest/userguide/getting-started.html#aws-iot-analytics-dataset-versions
|
1861
|
+
#
|
1862
|
+
# @option params [Array<Types::LateDataRule>] :late_data_rules
|
1863
|
+
# A list of data rules that send notifications to Amazon CloudWatch,
|
1864
|
+
# when data arrives late. To specify `lateDataRules`, the dataset must
|
1865
|
+
# use a [DeltaTimer][1] filter.
|
1866
|
+
#
|
1867
|
+
#
|
1868
|
+
#
|
1869
|
+
# [1]: https://docs.aws.amazon.com/iotanalytics/latest/APIReference/API_DeltaTime.html
|
1814
1870
|
#
|
1815
1871
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1816
1872
|
#
|
@@ -1893,6 +1949,16 @@ module Aws::IoTAnalytics
|
|
1893
1949
|
# unlimited: false,
|
1894
1950
|
# max_versions: 1,
|
1895
1951
|
# },
|
1952
|
+
# late_data_rules: [
|
1953
|
+
# {
|
1954
|
+
# rule_name: "LateDataRuleName",
|
1955
|
+
# rule_configuration: { # required
|
1956
|
+
# delta_time_session_window_configuration: {
|
1957
|
+
# timeout_in_minutes: 1, # required
|
1958
|
+
# },
|
1959
|
+
# },
|
1960
|
+
# },
|
1961
|
+
# ],
|
1896
1962
|
# })
|
1897
1963
|
#
|
1898
1964
|
# @overload update_dataset(params = {})
|
@@ -1913,10 +1979,10 @@ module Aws::IoTAnalytics
|
|
1913
1979
|
# customer-managed.
|
1914
1980
|
#
|
1915
1981
|
# @option params [Types::DatastoreStorage] :datastore_storage
|
1916
|
-
# Where data store data is stored. You
|
1917
|
-
#
|
1918
|
-
#
|
1919
|
-
# after the data store is created.
|
1982
|
+
# Where data store data is stored. You can choose one of
|
1983
|
+
# `serviceManagedS3` or `customerManagedS3` storage. If not specified,
|
1984
|
+
# the default is`serviceManagedS3`. You cannot change this storage
|
1985
|
+
# option after the data store is created.
|
1920
1986
|
#
|
1921
1987
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1922
1988
|
#
|
@@ -1954,15 +2020,15 @@ module Aws::IoTAnalytics
|
|
1954
2020
|
# The name of the pipeline to update.
|
1955
2021
|
#
|
1956
2022
|
# @option params [required, Array<Types::PipelineActivity>] :pipeline_activities
|
1957
|
-
# A list of
|
2023
|
+
# A list of `PipelineActivity` objects. Activities perform
|
1958
2024
|
# transformations on your messages, such as removing, renaming or adding
|
1959
2025
|
# message attributes; filtering messages based on attribute values;
|
1960
2026
|
# invoking your Lambda functions on messages for advanced processing; or
|
1961
2027
|
# performing mathematical transformations to normalize device data.
|
1962
2028
|
#
|
1963
|
-
# The list can be 2-25
|
1964
|
-
#
|
1965
|
-
#
|
2029
|
+
# The list can be 2-25 `PipelineActivity` objects and must contain both
|
2030
|
+
# a `channel` and a `datastore` activity. Each entry in the list must
|
2031
|
+
# contain only one activity. For example:
|
1966
2032
|
#
|
1967
2033
|
# `pipelineActivities = [ \{ "channel": \{ ... \} \}, \{ "lambda": \{
|
1968
2034
|
# ... \} \}, ... ]`
|
@@ -2056,7 +2122,7 @@ module Aws::IoTAnalytics
|
|
2056
2122
|
params: params,
|
2057
2123
|
config: config)
|
2058
2124
|
context[:gem_name] = 'aws-sdk-iotanalytics'
|
2059
|
-
context[:gem_version] = '1.
|
2125
|
+
context[:gem_version] = '1.35.0'
|
2060
2126
|
Seahorse::Client::Request.new(handlers, context)
|
2061
2127
|
end
|
2062
2128
|
|