aws-sdk-iotanalytics 1.32.0 → 1.37.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 +2 -1
- data/lib/aws-sdk-iotanalytics/client.rb +227 -89
- data/lib/aws-sdk-iotanalytics/client_api.rb +66 -0
- data/lib/aws-sdk-iotanalytics/types.rb +790 -319
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: eb2f60831d5e221bb2cfa8a76902e2d8dd67a255614170ec2f365e9dad096312
|
4
|
+
data.tar.gz: 8e4ee0a1829fec5969185fcc3f7d52aca08c33ee687c6f221ecf0bab8e27b624
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 33d97b0e5c78ad968d6827fbfd80903199ec240cbfe85455b347c1cffedfe72a9dfb1af518d68018cc961313fc39d89ec560c59dbd8e612b1a18592ca1ac473d
|
7
|
+
data.tar.gz: d7e4b03b5c6157adefff48cf0bbf9835c503512e470f12bb712db1ae96f4ef9b97e4839c75131f1ee277a7b546425280b6e516a7482500d5f9a8fd54601520c6
|
data/lib/aws-sdk-iotanalytics.rb
CHANGED
@@ -7,6 +7,7 @@
|
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
10
|
+
|
10
11
|
require 'aws-sdk-core'
|
11
12
|
require 'aws-sigv4'
|
12
13
|
|
@@ -47,6 +48,6 @@ require_relative 'aws-sdk-iotanalytics/customizations'
|
|
47
48
|
# @!group service
|
48
49
|
module Aws::IoTAnalytics
|
49
50
|
|
50
|
-
GEM_VERSION = '1.
|
51
|
+
GEM_VERSION = '1.37.0'
|
51
52
|
|
52
53
|
end
|
@@ -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,18 +697,30 @@ 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.
|
675
711
|
#
|
712
|
+
# @option params [Types::FileFormatConfiguration] :file_format_configuration
|
713
|
+
# Contains the configuration information of file formats. AWS IoT
|
714
|
+
# Analytics data stores support JSON and [Parquet][1].
|
715
|
+
#
|
716
|
+
# The default file format is JSON. You can specify only one format.
|
717
|
+
#
|
718
|
+
# You can't change the file format after you create the data store.
|
719
|
+
#
|
720
|
+
#
|
721
|
+
#
|
722
|
+
# [1]: https://parquet.apache.org/
|
723
|
+
#
|
676
724
|
# @return [Types::CreateDatastoreResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
677
725
|
#
|
678
726
|
# * {Types::CreateDatastoreResponse#datastore_name #datastore_name} => String
|
@@ -702,6 +750,20 @@ module Aws::IoTAnalytics
|
|
702
750
|
# value: "TagValue", # required
|
703
751
|
# },
|
704
752
|
# ],
|
753
|
+
# file_format_configuration: {
|
754
|
+
# json_configuration: {
|
755
|
+
# },
|
756
|
+
# parquet_configuration: {
|
757
|
+
# schema_definition: {
|
758
|
+
# columns: [
|
759
|
+
# {
|
760
|
+
# name: "ColumnName", # required
|
761
|
+
# type: "ColumnDataType", # required
|
762
|
+
# },
|
763
|
+
# ],
|
764
|
+
# },
|
765
|
+
# },
|
766
|
+
# },
|
705
767
|
# })
|
706
768
|
#
|
707
769
|
# @example Response structure
|
@@ -728,15 +790,15 @@ module Aws::IoTAnalytics
|
|
728
790
|
# The name of the pipeline.
|
729
791
|
#
|
730
792
|
# @option params [required, Array<Types::PipelineActivity>] :pipeline_activities
|
731
|
-
# A list of
|
793
|
+
# A list of `PipelineActivity` objects. Activities perform
|
732
794
|
# transformations on your messages, such as removing, renaming or adding
|
733
795
|
# message attributes; filtering messages based on attribute values;
|
734
796
|
# invoking your Lambda functions on messages for advanced processing; or
|
735
797
|
# performing mathematical transformations to normalize device data.
|
736
798
|
#
|
737
|
-
# The list can be 2-25
|
738
|
-
#
|
739
|
-
#
|
799
|
+
# The list can be 2-25 `PipelineActivity` objects and must contain both
|
800
|
+
# a `channel` and a `datastore` activity. Each entry in the list must
|
801
|
+
# contain only one activity. For example:
|
740
802
|
#
|
741
803
|
# `pipelineActivities = [ \{ "channel": \{ ... \} \}, \{ "lambda": \{
|
742
804
|
# ... \} \}, ... ]`
|
@@ -854,9 +916,9 @@ module Aws::IoTAnalytics
|
|
854
916
|
req.send_request(options)
|
855
917
|
end
|
856
918
|
|
857
|
-
# Deletes the specified
|
919
|
+
# Deletes the specified dataset.
|
858
920
|
#
|
859
|
-
# You do not have to delete the content of the
|
921
|
+
# You do not have to delete the content of the dataset before you
|
860
922
|
# perform this operation.
|
861
923
|
#
|
862
924
|
# @option params [required, String] :dataset_name
|
@@ -877,13 +939,13 @@ module Aws::IoTAnalytics
|
|
877
939
|
req.send_request(options)
|
878
940
|
end
|
879
941
|
|
880
|
-
# Deletes the content of the specified
|
942
|
+
# Deletes the content of the specified dataset.
|
881
943
|
#
|
882
944
|
# @option params [required, String] :dataset_name
|
883
|
-
# The name of the
|
945
|
+
# The name of the dataset whose content is deleted.
|
884
946
|
#
|
885
947
|
# @option params [String] :version_id
|
886
|
-
# The version of the
|
948
|
+
# The version of the dataset whose content is deleted. You can also use
|
887
949
|
# the strings "$LATEST" or "$LATEST\_SUCCEEDED" to delete the latest
|
888
950
|
# or latest successfully completed data set. If not specified,
|
889
951
|
# "$LATEST\_SUCCEEDED" is the default.
|
@@ -978,6 +1040,7 @@ module Aws::IoTAnalytics
|
|
978
1040
|
# resp.channel.retention_period.number_of_days #=> Integer
|
979
1041
|
# resp.channel.creation_time #=> Time
|
980
1042
|
# resp.channel.last_update_time #=> Time
|
1043
|
+
# resp.channel.last_message_arrival_time #=> Time
|
981
1044
|
# resp.statistics.size.estimated_size_in_bytes #=> Float
|
982
1045
|
# resp.statistics.size.estimated_on #=> Time
|
983
1046
|
#
|
@@ -988,7 +1051,7 @@ module Aws::IoTAnalytics
|
|
988
1051
|
req.send_request(options)
|
989
1052
|
end
|
990
1053
|
|
991
|
-
# Retrieves information about a
|
1054
|
+
# Retrieves information about a dataset.
|
992
1055
|
#
|
993
1056
|
# @option params [required, String] :dataset_name
|
994
1057
|
# The name of the data set whose information is retrieved.
|
@@ -1042,6 +1105,9 @@ module Aws::IoTAnalytics
|
|
1042
1105
|
# resp.dataset.retention_period.number_of_days #=> Integer
|
1043
1106
|
# resp.dataset.versioning_configuration.unlimited #=> Boolean
|
1044
1107
|
# resp.dataset.versioning_configuration.max_versions #=> Integer
|
1108
|
+
# resp.dataset.late_data_rules #=> Array
|
1109
|
+
# resp.dataset.late_data_rules[0].rule_name #=> String
|
1110
|
+
# resp.dataset.late_data_rules[0].rule_configuration.delta_time_session_window_configuration.timeout_in_minutes #=> Integer
|
1045
1111
|
#
|
1046
1112
|
# @overload describe_dataset(params = {})
|
1047
1113
|
# @param [Hash] params ({})
|
@@ -1084,6 +1150,10 @@ module Aws::IoTAnalytics
|
|
1084
1150
|
# resp.datastore.retention_period.number_of_days #=> Integer
|
1085
1151
|
# resp.datastore.creation_time #=> Time
|
1086
1152
|
# resp.datastore.last_update_time #=> Time
|
1153
|
+
# resp.datastore.last_message_arrival_time #=> Time
|
1154
|
+
# resp.datastore.file_format_configuration.parquet_configuration.schema_definition.columns #=> Array
|
1155
|
+
# resp.datastore.file_format_configuration.parquet_configuration.schema_definition.columns[0].name #=> String
|
1156
|
+
# resp.datastore.file_format_configuration.parquet_configuration.schema_definition.columns[0].type #=> String
|
1087
1157
|
# resp.statistics.size.estimated_size_in_bytes #=> Float
|
1088
1158
|
# resp.statistics.size.estimated_on #=> Time
|
1089
1159
|
#
|
@@ -1186,7 +1256,7 @@ module Aws::IoTAnalytics
|
|
1186
1256
|
req.send_request(options)
|
1187
1257
|
end
|
1188
1258
|
|
1189
|
-
# Retrieves the contents of a data set as
|
1259
|
+
# Retrieves the contents of a data set as presigned URIs.
|
1190
1260
|
#
|
1191
1261
|
# @option params [required, String] :dataset_name
|
1192
1262
|
# The name of the data set whose contents are retrieved.
|
@@ -1260,6 +1330,7 @@ module Aws::IoTAnalytics
|
|
1260
1330
|
# resp.channel_summaries[0].status #=> String, one of "CREATING", "ACTIVE", "DELETING"
|
1261
1331
|
# resp.channel_summaries[0].creation_time #=> Time
|
1262
1332
|
# resp.channel_summaries[0].last_update_time #=> Time
|
1333
|
+
# resp.channel_summaries[0].last_message_arrival_time #=> Time
|
1263
1334
|
# resp.next_token #=> String
|
1264
1335
|
#
|
1265
1336
|
# @overload list_channels(params = {})
|
@@ -1283,12 +1354,12 @@ module Aws::IoTAnalytics
|
|
1283
1354
|
# @option params [Time,DateTime,Date,Integer,String] :scheduled_on_or_after
|
1284
1355
|
# A filter to limit results to those data set contents whose creation is
|
1285
1356
|
# scheduled on or after the given time. See the field
|
1286
|
-
# `triggers.schedule` in the CreateDataset request. (timestamp)
|
1357
|
+
# `triggers.schedule` in the `CreateDataset` request. (timestamp)
|
1287
1358
|
#
|
1288
1359
|
# @option params [Time,DateTime,Date,Integer,String] :scheduled_before
|
1289
1360
|
# A filter to limit results to those data set contents whose creation is
|
1290
1361
|
# scheduled before the given time. See the field `triggers.schedule` in
|
1291
|
-
# the CreateDataset request. (timestamp)
|
1362
|
+
# the `CreateDataset` request. (timestamp)
|
1292
1363
|
#
|
1293
1364
|
# @return [Types::ListDatasetContentsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1294
1365
|
#
|
@@ -1405,6 +1476,8 @@ module Aws::IoTAnalytics
|
|
1405
1476
|
# resp.datastore_summaries[0].status #=> String, one of "CREATING", "ACTIVE", "DELETING"
|
1406
1477
|
# resp.datastore_summaries[0].creation_time #=> Time
|
1407
1478
|
# resp.datastore_summaries[0].last_update_time #=> Time
|
1479
|
+
# resp.datastore_summaries[0].last_message_arrival_time #=> Time
|
1480
|
+
# resp.datastore_summaries[0].file_format_type #=> String, one of "JSON", "PARQUET"
|
1408
1481
|
# resp.next_token #=> String
|
1409
1482
|
#
|
1410
1483
|
# @overload list_datastores(params = {})
|
@@ -1457,7 +1530,7 @@ module Aws::IoTAnalytics
|
|
1457
1530
|
req.send_request(options)
|
1458
1531
|
end
|
1459
1532
|
|
1460
|
-
# Lists the tags (metadata)
|
1533
|
+
# Lists the tags (metadata) that you have assigned to the resource.
|
1461
1534
|
#
|
1462
1535
|
# @option params [required, String] :resource_arn
|
1463
1536
|
# The ARN of the resource whose tags you want to list.
|
@@ -1487,11 +1560,11 @@ module Aws::IoTAnalytics
|
|
1487
1560
|
|
1488
1561
|
# Sets or updates the AWS IoT Analytics logging options.
|
1489
1562
|
#
|
1490
|
-
#
|
1491
|
-
#
|
1492
|
-
#
|
1493
|
-
#
|
1494
|
-
#
|
1563
|
+
# If you update the value of any `loggingOptions` field, it takes up to
|
1564
|
+
# one minute for the change to take effect. Also, if you change the
|
1565
|
+
# policy attached to the role you specified in the `roleArn` field (for
|
1566
|
+
# example, to correct an invalid policy), it takes up to five minutes
|
1567
|
+
# for that change to take effect.
|
1495
1568
|
#
|
1496
1569
|
# @option params [required, Types::LoggingOptions] :logging_options
|
1497
1570
|
# The new values of the AWS IoT Analytics logging options.
|
@@ -1519,12 +1592,12 @@ module Aws::IoTAnalytics
|
|
1519
1592
|
# payload.
|
1520
1593
|
#
|
1521
1594
|
# @option params [required, Types::PipelineActivity] :pipeline_activity
|
1522
|
-
# The pipeline activity that is run. This must not be a
|
1523
|
-
#
|
1524
|
-
#
|
1525
|
-
#
|
1526
|
-
#
|
1527
|
-
#
|
1595
|
+
# The pipeline activity that is run. This must not be a channel activity
|
1596
|
+
# or a datastore activity because these activities are used in a
|
1597
|
+
# pipeline only to load the original message and to store the (possibly)
|
1598
|
+
# transformed message. If a lambda activity is specified, only
|
1599
|
+
# short-running Lambda functions (those with a timeout of less than 30
|
1600
|
+
# seconds or less) can be used.
|
1528
1601
|
#
|
1529
1602
|
# @option params [required, Array<String, StringIO, File>] :payloads
|
1530
1603
|
# The sample message payloads on which the pipeline activity is run.
|
@@ -1619,7 +1692,7 @@ module Aws::IoTAnalytics
|
|
1619
1692
|
# The name of the channel whose message samples are retrieved.
|
1620
1693
|
#
|
1621
1694
|
# @option params [Integer] :max_messages
|
1622
|
-
# The number of sample messages to be retrieved. The limit is 10
|
1695
|
+
# The number of sample messages to be retrieved. The limit is 10. The
|
1623
1696
|
# default is also 10.
|
1624
1697
|
#
|
1625
1698
|
# @option params [Time,DateTime,Date,Integer,String] :start_time
|
@@ -1661,9 +1734,22 @@ module Aws::IoTAnalytics
|
|
1661
1734
|
# @option params [Time,DateTime,Date,Integer,String] :start_time
|
1662
1735
|
# The start time (inclusive) of raw message data that is reprocessed.
|
1663
1736
|
#
|
1737
|
+
# If you specify a value for the `startTime` parameter, you must not use
|
1738
|
+
# the `channelMessages` object.
|
1739
|
+
#
|
1664
1740
|
# @option params [Time,DateTime,Date,Integer,String] :end_time
|
1665
1741
|
# The end time (exclusive) of raw message data that is reprocessed.
|
1666
1742
|
#
|
1743
|
+
# If you specify a value for the `endTime` parameter, you must not use
|
1744
|
+
# the `channelMessages` object.
|
1745
|
+
#
|
1746
|
+
# @option params [Types::ChannelMessages] :channel_messages
|
1747
|
+
# Specifies one or more sets of channel messages that you want to
|
1748
|
+
# reprocess.
|
1749
|
+
#
|
1750
|
+
# If you use the `channelMessages` object, you must not specify a value
|
1751
|
+
# for `startTime` and `endTime`.
|
1752
|
+
#
|
1667
1753
|
# @return [Types::StartPipelineReprocessingResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1668
1754
|
#
|
1669
1755
|
# * {Types::StartPipelineReprocessingResponse#reprocessing_id #reprocessing_id} => String
|
@@ -1674,6 +1760,9 @@ module Aws::IoTAnalytics
|
|
1674
1760
|
# pipeline_name: "PipelineName", # required
|
1675
1761
|
# start_time: Time.now,
|
1676
1762
|
# end_time: Time.now,
|
1763
|
+
# channel_messages: {
|
1764
|
+
# s3_paths: ["S3PathChannelMessage"],
|
1765
|
+
# },
|
1677
1766
|
# })
|
1678
1767
|
#
|
1679
1768
|
# @example Response structure
|
@@ -1688,7 +1777,7 @@ module Aws::IoTAnalytics
|
|
1688
1777
|
end
|
1689
1778
|
|
1690
1779
|
# Adds to or modifies the tags of the given resource. Tags are metadata
|
1691
|
-
#
|
1780
|
+
# that can be used to manage a resource.
|
1692
1781
|
#
|
1693
1782
|
# @option params [required, String] :resource_arn
|
1694
1783
|
# The ARN of the resource whose tags you want to modify.
|
@@ -1747,10 +1836,10 @@ module Aws::IoTAnalytics
|
|
1747
1836
|
# The name of the channel to be updated.
|
1748
1837
|
#
|
1749
1838
|
# @option params [Types::ChannelStorage] :channel_storage
|
1750
|
-
# Where channel data is stored. You
|
1751
|
-
#
|
1752
|
-
#
|
1753
|
-
#
|
1839
|
+
# Where channel data is stored. You can choose one of `serviceManagedS3`
|
1840
|
+
# or `customerManagedS3` storage. If not specified, the default is
|
1841
|
+
# `serviceManagedS3`. You cannot change this storage option after the
|
1842
|
+
# channel is created.
|
1754
1843
|
#
|
1755
1844
|
# @option params [Types::RetentionPeriod] :retention_period
|
1756
1845
|
# How long, in days, message data is kept for the channel. The retention
|
@@ -1791,26 +1880,39 @@ module Aws::IoTAnalytics
|
|
1791
1880
|
# The name of the data set to update.
|
1792
1881
|
#
|
1793
1882
|
# @option params [required, Array<Types::DatasetAction>] :actions
|
1794
|
-
# A list of
|
1883
|
+
# A list of `DatasetAction` objects.
|
1795
1884
|
#
|
1796
1885
|
# @option params [Array<Types::DatasetTrigger>] :triggers
|
1797
|
-
# A list of
|
1798
|
-
# contain up to five
|
1886
|
+
# A list of `DatasetTrigger` objects. The list can be empty or can
|
1887
|
+
# contain up to five `DatasetTrigger` objects.
|
1799
1888
|
#
|
1800
1889
|
# @option params [Array<Types::DatasetContentDeliveryRule>] :content_delivery_rules
|
1801
|
-
# When
|
1890
|
+
# When dataset contents are created, they are delivered to destinations
|
1802
1891
|
# specified here.
|
1803
1892
|
#
|
1804
1893
|
# @option params [Types::RetentionPeriod] :retention_period
|
1805
|
-
# How long, in days,
|
1894
|
+
# How long, in days, dataset contents are kept for the dataset.
|
1806
1895
|
#
|
1807
1896
|
# @option params [Types::VersioningConfiguration] :versioning_configuration
|
1808
|
-
#
|
1897
|
+
# Optional. How many versions of dataset contents are kept. If not
|
1809
1898
|
# specified or set to null, only the latest version plus the latest
|
1810
1899
|
# succeeded version (if they are different) are kept for the time period
|
1811
|
-
# specified by the
|
1812
|
-
# see
|
1813
|
-
#
|
1900
|
+
# specified by the `retentionPeriod` parameter. For more information,
|
1901
|
+
# see [Keeping Multiple Versions of AWS IoT Analytics Data Sets][1] in
|
1902
|
+
# the *AWS IoT Analytics User Guide*.
|
1903
|
+
#
|
1904
|
+
#
|
1905
|
+
#
|
1906
|
+
# [1]: https://docs.aws.amazon.com/iotanalytics/latest/userguide/getting-started.html#aws-iot-analytics-dataset-versions
|
1907
|
+
#
|
1908
|
+
# @option params [Array<Types::LateDataRule>] :late_data_rules
|
1909
|
+
# A list of data rules that send notifications to Amazon CloudWatch,
|
1910
|
+
# when data arrives late. To specify `lateDataRules`, the dataset must
|
1911
|
+
# use a [DeltaTimer][1] filter.
|
1912
|
+
#
|
1913
|
+
#
|
1914
|
+
#
|
1915
|
+
# [1]: https://docs.aws.amazon.com/iotanalytics/latest/APIReference/API_DeltaTime.html
|
1814
1916
|
#
|
1815
1917
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1816
1918
|
#
|
@@ -1893,6 +1995,16 @@ module Aws::IoTAnalytics
|
|
1893
1995
|
# unlimited: false,
|
1894
1996
|
# max_versions: 1,
|
1895
1997
|
# },
|
1998
|
+
# late_data_rules: [
|
1999
|
+
# {
|
2000
|
+
# rule_name: "LateDataRuleName",
|
2001
|
+
# rule_configuration: { # required
|
2002
|
+
# delta_time_session_window_configuration: {
|
2003
|
+
# timeout_in_minutes: 1, # required
|
2004
|
+
# },
|
2005
|
+
# },
|
2006
|
+
# },
|
2007
|
+
# ],
|
1896
2008
|
# })
|
1897
2009
|
#
|
1898
2010
|
# @overload update_dataset(params = {})
|
@@ -1913,10 +2025,22 @@ module Aws::IoTAnalytics
|
|
1913
2025
|
# customer-managed.
|
1914
2026
|
#
|
1915
2027
|
# @option params [Types::DatastoreStorage] :datastore_storage
|
1916
|
-
# Where data store data is stored. You
|
1917
|
-
#
|
1918
|
-
#
|
1919
|
-
# after the data store is created.
|
2028
|
+
# Where data store data is stored. You can choose one of
|
2029
|
+
# `serviceManagedS3` or `customerManagedS3` storage. If not specified,
|
2030
|
+
# the default is`serviceManagedS3`. You cannot change this storage
|
2031
|
+
# option after the data store is created.
|
2032
|
+
#
|
2033
|
+
# @option params [Types::FileFormatConfiguration] :file_format_configuration
|
2034
|
+
# Contains the configuration information of file formats. AWS IoT
|
2035
|
+
# Analytics data stores support JSON and [Parquet][1].
|
2036
|
+
#
|
2037
|
+
# The default file format is JSON. You can specify only one format.
|
2038
|
+
#
|
2039
|
+
# You can't change the file format after you create the data store.
|
2040
|
+
#
|
2041
|
+
#
|
2042
|
+
#
|
2043
|
+
# [1]: https://parquet.apache.org/
|
1920
2044
|
#
|
1921
2045
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1922
2046
|
#
|
@@ -1937,6 +2061,20 @@ module Aws::IoTAnalytics
|
|
1937
2061
|
# role_arn: "RoleArn", # required
|
1938
2062
|
# },
|
1939
2063
|
# },
|
2064
|
+
# file_format_configuration: {
|
2065
|
+
# json_configuration: {
|
2066
|
+
# },
|
2067
|
+
# parquet_configuration: {
|
2068
|
+
# schema_definition: {
|
2069
|
+
# columns: [
|
2070
|
+
# {
|
2071
|
+
# name: "ColumnName", # required
|
2072
|
+
# type: "ColumnDataType", # required
|
2073
|
+
# },
|
2074
|
+
# ],
|
2075
|
+
# },
|
2076
|
+
# },
|
2077
|
+
# },
|
1940
2078
|
# })
|
1941
2079
|
#
|
1942
2080
|
# @overload update_datastore(params = {})
|
@@ -1954,15 +2092,15 @@ module Aws::IoTAnalytics
|
|
1954
2092
|
# The name of the pipeline to update.
|
1955
2093
|
#
|
1956
2094
|
# @option params [required, Array<Types::PipelineActivity>] :pipeline_activities
|
1957
|
-
# A list of
|
2095
|
+
# A list of `PipelineActivity` objects. Activities perform
|
1958
2096
|
# transformations on your messages, such as removing, renaming or adding
|
1959
2097
|
# message attributes; filtering messages based on attribute values;
|
1960
2098
|
# invoking your Lambda functions on messages for advanced processing; or
|
1961
2099
|
# performing mathematical transformations to normalize device data.
|
1962
2100
|
#
|
1963
|
-
# The list can be 2-25
|
1964
|
-
#
|
1965
|
-
#
|
2101
|
+
# The list can be 2-25 `PipelineActivity` objects and must contain both
|
2102
|
+
# a `channel` and a `datastore` activity. Each entry in the list must
|
2103
|
+
# contain only one activity. For example:
|
1966
2104
|
#
|
1967
2105
|
# `pipelineActivities = [ \{ "channel": \{ ... \} \}, \{ "lambda": \{
|
1968
2106
|
# ... \} \}, ... ]`
|
@@ -2056,7 +2194,7 @@ module Aws::IoTAnalytics
|
|
2056
2194
|
params: params,
|
2057
2195
|
config: config)
|
2058
2196
|
context[:gem_name] = 'aws-sdk-iotanalytics'
|
2059
|
-
context[:gem_version] = '1.
|
2197
|
+
context[:gem_version] = '1.37.0'
|
2060
2198
|
Seahorse::Client::Request.new(handlers, context)
|
2061
2199
|
end
|
2062
2200
|
|