aws-sdk-iotanalytics 1.30.1 → 1.35.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-iotanalytics.rb +5 -2
- data/lib/aws-sdk-iotanalytics/client.rb +181 -98
- data/lib/aws-sdk-iotanalytics/client_api.rb +28 -0
- data/lib/aws-sdk-iotanalytics/errors.rb +2 -0
- data/lib/aws-sdk-iotanalytics/resource.rb +2 -0
- data/lib/aws-sdk-iotanalytics/types.rb +662 -316
- metadata +4 -4
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
@@ -1,3 +1,5 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
1
3
|
# WARNING ABOUT GENERATED CODE
|
2
4
|
#
|
3
5
|
# This file is generated. See the contributing guide for more information:
|
@@ -5,6 +7,7 @@
|
|
5
7
|
#
|
6
8
|
# WARNING ABOUT GENERATED CODE
|
7
9
|
|
10
|
+
|
8
11
|
require 'aws-sdk-core'
|
9
12
|
require 'aws-sigv4'
|
10
13
|
|
@@ -42,9 +45,9 @@ require_relative 'aws-sdk-iotanalytics/customizations'
|
|
42
45
|
#
|
43
46
|
# See {Errors} for more information.
|
44
47
|
#
|
45
|
-
#
|
48
|
+
# @!group service
|
46
49
|
module Aws::IoTAnalytics
|
47
50
|
|
48
|
-
GEM_VERSION = '1.
|
51
|
+
GEM_VERSION = '1.35.0'
|
49
52
|
|
50
53
|
end
|
@@ -1,3 +1,5 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
1
3
|
# WARNING ABOUT GENERATED CODE
|
2
4
|
#
|
3
5
|
# This file is generated. See the contributing guide for more information:
|
@@ -83,13 +85,28 @@ module Aws::IoTAnalytics
|
|
83
85
|
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
84
86
|
# credentials.
|
85
87
|
#
|
88
|
+
# * `Aws::SharedCredentials` - Used for loading static credentials from a
|
89
|
+
# shared file, such as `~/.aws/config`.
|
90
|
+
#
|
91
|
+
# * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
|
92
|
+
#
|
93
|
+
# * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
|
94
|
+
# assume a role after providing credentials via the web.
|
95
|
+
#
|
96
|
+
# * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
|
97
|
+
# access token generated from `aws login`.
|
98
|
+
#
|
99
|
+
# * `Aws::ProcessCredentials` - Used for loading credentials from a
|
100
|
+
# process that outputs to stdout.
|
101
|
+
#
|
86
102
|
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
|
87
103
|
# from an EC2 IMDS on an EC2 instance.
|
88
104
|
#
|
89
|
-
# * `Aws::
|
90
|
-
#
|
105
|
+
# * `Aws::ECSCredentials` - Used for loading credentials from
|
106
|
+
# instances running in ECS.
|
91
107
|
#
|
92
|
-
# * `Aws::
|
108
|
+
# * `Aws::CognitoIdentityCredentials` - Used for loading credentials
|
109
|
+
# from the Cognito Identity service.
|
93
110
|
#
|
94
111
|
# When `:credentials` are not configured directly, the following
|
95
112
|
# locations will be searched for credentials:
|
@@ -99,10 +116,10 @@ module Aws::IoTAnalytics
|
|
99
116
|
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
|
100
117
|
# * `~/.aws/credentials`
|
101
118
|
# * `~/.aws/config`
|
102
|
-
# * EC2 IMDS instance profile - When used by default, the timeouts
|
103
|
-
# very aggressive. Construct and pass an instance of
|
104
|
-
# `Aws::InstanceProfileCredentails`
|
105
|
-
# timeouts.
|
119
|
+
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
120
|
+
# are very aggressive. Construct and pass an instance of
|
121
|
+
# `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
|
122
|
+
# enable retries and extended timeouts.
|
106
123
|
#
|
107
124
|
# @option options [required, String] :region
|
108
125
|
# The AWS region to connect to. The configured `:region` is
|
@@ -316,13 +333,13 @@ module Aws::IoTAnalytics
|
|
316
333
|
# The name of the channel where the messages are sent.
|
317
334
|
#
|
318
335
|
# @option params [required, Array<Types::Message>] :messages
|
319
|
-
# The list of messages to be sent. Each message has format:
|
320
|
-
# "messageId": "string", "payload": "string"\\}
|
336
|
+
# The list of messages to be sent. Each message has the format: \\\{
|
337
|
+
# "messageId": "string", "payload": "string"\\}.
|
321
338
|
#
|
322
|
-
#
|
323
|
-
#
|
339
|
+
# The field names of message payloads (data) that you send to AWS IoT
|
340
|
+
# Analytics:
|
324
341
|
#
|
325
|
-
# * Must contain only alphanumeric characters and undescores (\_)
|
342
|
+
# * Must contain only alphanumeric characters and undescores (\_). No
|
326
343
|
# other special characters are allowed.
|
327
344
|
#
|
328
345
|
# * Must begin with an alphabetic character or single underscore (\_).
|
@@ -332,10 +349,10 @@ module Aws::IoTAnalytics
|
|
332
349
|
# * In regular expression terms:
|
333
350
|
# "^\[A-Za-z\_\](\[A-Za-z0-9\]*\|\[A-Za-z0-9\]\[A-Za-z0-9\_\]*)$".
|
334
351
|
#
|
335
|
-
# * Cannot be
|
352
|
+
# * Cannot be more than 255 characters.
|
336
353
|
#
|
337
|
-
# * Are case
|
338
|
-
#
|
354
|
+
# * Are case insensitive. (Fields named foo and FOO in the same payload
|
355
|
+
# are considered duplicates.)
|
339
356
|
#
|
340
357
|
# For example, \\\{"temp\_01": 29\\} or \\\{"\_temp\_01": 29\\} are
|
341
358
|
# valid, but \\\{"temp-01": 29\\}, \\\{"01\_temp": 29\\} or
|
@@ -378,7 +395,7 @@ module Aws::IoTAnalytics
|
|
378
395
|
#
|
379
396
|
# @option params [required, String] :reprocessing_id
|
380
397
|
# The ID of the reprocessing task (returned by
|
381
|
-
#
|
398
|
+
# `StartPipelineReprocessing`).
|
382
399
|
#
|
383
400
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
384
401
|
#
|
@@ -404,14 +421,14 @@ module Aws::IoTAnalytics
|
|
404
421
|
# The name of the channel.
|
405
422
|
#
|
406
423
|
# @option params [Types::ChannelStorage] :channel_storage
|
407
|
-
# Where channel data is stored. You
|
408
|
-
#
|
409
|
-
#
|
410
|
-
#
|
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.
|
411
428
|
#
|
412
429
|
# @option params [Types::RetentionPeriod] :retention_period
|
413
430
|
# How long, in days, message data is kept for the channel. When
|
414
|
-
#
|
431
|
+
# `customerManagedS3` storage is selected, this parameter is ignored.
|
415
432
|
#
|
416
433
|
# @option params [Array<Types::Tag>] :tags
|
417
434
|
# Metadata which can be used to manage the channel.
|
@@ -461,12 +478,12 @@ module Aws::IoTAnalytics
|
|
461
478
|
req.send_request(options)
|
462
479
|
end
|
463
480
|
|
464
|
-
# Creates a
|
465
|
-
# 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`
|
466
483
|
# (executing a containerized application). This operation creates the
|
467
|
-
# skeleton of a
|
468
|
-
# calling
|
469
|
-
#
|
484
|
+
# skeleton of a dataset. The dataset can be populated manually by
|
485
|
+
# calling `CreateDatasetContent` or automatically according to a trigger
|
486
|
+
# you specify.
|
470
487
|
#
|
471
488
|
# @option params [required, String] :dataset_name
|
472
489
|
# The name of the data set.
|
@@ -478,31 +495,49 @@ module Aws::IoTAnalytics
|
|
478
495
|
# A list of triggers. A trigger causes data set contents to be populated
|
479
496
|
# at a specified time interval or when another data set's contents are
|
480
497
|
# created. The list of triggers can be empty or contain up to five
|
481
|
-
#
|
498
|
+
# `DataSetTrigger` objects.
|
482
499
|
#
|
483
500
|
# @option params [Array<Types::DatasetContentDeliveryRule>] :content_delivery_rules
|
484
|
-
# When
|
501
|
+
# When dataset contents are created, they are delivered to destinations
|
485
502
|
# specified here.
|
486
503
|
#
|
487
504
|
# @option params [Types::RetentionPeriod] :retention_period
|
488
|
-
#
|
489
|
-
#
|
490
|
-
#
|
491
|
-
#
|
492
|
-
# `versioningConfiguration` parameter.
|
493
|
-
#
|
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
|
494
516
|
#
|
495
517
|
# @option params [Types::VersioningConfiguration] :versioning_configuration
|
496
|
-
#
|
518
|
+
# Optional. How many versions of dataset contents are kept. If not
|
497
519
|
# specified or set to null, only the latest version plus the latest
|
498
520
|
# succeeded version (if they are different) are kept for the time period
|
499
|
-
# specified by the
|
500
|
-
# see
|
501
|
-
#
|
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
|
502
528
|
#
|
503
529
|
# @option params [Array<Types::Tag>] :tags
|
504
530
|
# Metadata which can be used to manage the data set.
|
505
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
|
+
#
|
506
541
|
# @return [Types::CreateDatasetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
507
542
|
#
|
508
543
|
# * {Types::CreateDatasetResponse#dataset_name #dataset_name} => String
|
@@ -594,6 +629,16 @@ module Aws::IoTAnalytics
|
|
594
629
|
# value: "TagValue", # required
|
595
630
|
# },
|
596
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
|
+
# ],
|
597
642
|
# })
|
598
643
|
#
|
599
644
|
# @example Response structure
|
@@ -610,12 +655,19 @@ module Aws::IoTAnalytics
|
|
610
655
|
req.send_request(options)
|
611
656
|
end
|
612
657
|
|
613
|
-
# Creates the content of a data set by applying a
|
614
|
-
# query) or a
|
615
|
-
# application).
|
658
|
+
# Creates the content of a data set by applying a `queryAction` (a SQL
|
659
|
+
# query) or a `containerAction` (executing a containerized application).
|
616
660
|
#
|
617
661
|
# @option params [required, String] :dataset_name
|
618
|
-
# 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
|
619
671
|
#
|
620
672
|
# @return [Types::CreateDatasetContentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
621
673
|
#
|
@@ -625,6 +677,7 @@ module Aws::IoTAnalytics
|
|
625
677
|
#
|
626
678
|
# resp = client.create_dataset_content({
|
627
679
|
# dataset_name: "DatasetName", # required
|
680
|
+
# version_id: "DatasetContentVersion",
|
628
681
|
# })
|
629
682
|
#
|
630
683
|
# @example Response structure
|
@@ -644,14 +697,14 @@ module Aws::IoTAnalytics
|
|
644
697
|
# The name of the data store.
|
645
698
|
#
|
646
699
|
# @option params [Types::DatastoreStorage] :datastore_storage
|
647
|
-
# Where data store data is stored. You
|
648
|
-
#
|
649
|
-
#
|
650
|
-
# 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.
|
651
704
|
#
|
652
705
|
# @option params [Types::RetentionPeriod] :retention_period
|
653
706
|
# How long, in days, message data is kept for the data store. When
|
654
|
-
#
|
707
|
+
# `customerManagedS3` storage is selected, this parameter is ignored.
|
655
708
|
#
|
656
709
|
# @option params [Array<Types::Tag>] :tags
|
657
710
|
# Metadata which can be used to manage the data store.
|
@@ -711,15 +764,15 @@ module Aws::IoTAnalytics
|
|
711
764
|
# The name of the pipeline.
|
712
765
|
#
|
713
766
|
# @option params [required, Array<Types::PipelineActivity>] :pipeline_activities
|
714
|
-
# A list of
|
767
|
+
# A list of `PipelineActivity` objects. Activities perform
|
715
768
|
# transformations on your messages, such as removing, renaming or adding
|
716
769
|
# message attributes; filtering messages based on attribute values;
|
717
770
|
# invoking your Lambda functions on messages for advanced processing; or
|
718
771
|
# performing mathematical transformations to normalize device data.
|
719
772
|
#
|
720
|
-
# The list can be 2-25
|
721
|
-
#
|
722
|
-
#
|
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:
|
723
776
|
#
|
724
777
|
# `pipelineActivities = [ \{ "channel": \{ ... \} \}, \{ "lambda": \{
|
725
778
|
# ... \} \}, ... ]`
|
@@ -837,9 +890,9 @@ module Aws::IoTAnalytics
|
|
837
890
|
req.send_request(options)
|
838
891
|
end
|
839
892
|
|
840
|
-
# Deletes the specified
|
893
|
+
# Deletes the specified dataset.
|
841
894
|
#
|
842
|
-
# You do not have to delete the content of the
|
895
|
+
# You do not have to delete the content of the dataset before you
|
843
896
|
# perform this operation.
|
844
897
|
#
|
845
898
|
# @option params [required, String] :dataset_name
|
@@ -860,13 +913,13 @@ module Aws::IoTAnalytics
|
|
860
913
|
req.send_request(options)
|
861
914
|
end
|
862
915
|
|
863
|
-
# Deletes the content of the specified
|
916
|
+
# Deletes the content of the specified dataset.
|
864
917
|
#
|
865
918
|
# @option params [required, String] :dataset_name
|
866
|
-
# The name of the
|
919
|
+
# The name of the dataset whose content is deleted.
|
867
920
|
#
|
868
921
|
# @option params [String] :version_id
|
869
|
-
# The version of the
|
922
|
+
# The version of the dataset whose content is deleted. You can also use
|
870
923
|
# the strings "$LATEST" or "$LATEST\_SUCCEEDED" to delete the latest
|
871
924
|
# or latest successfully completed data set. If not specified,
|
872
925
|
# "$LATEST\_SUCCEEDED" is the default.
|
@@ -961,6 +1014,7 @@ module Aws::IoTAnalytics
|
|
961
1014
|
# resp.channel.retention_period.number_of_days #=> Integer
|
962
1015
|
# resp.channel.creation_time #=> Time
|
963
1016
|
# resp.channel.last_update_time #=> Time
|
1017
|
+
# resp.channel.last_message_arrival_time #=> Time
|
964
1018
|
# resp.statistics.size.estimated_size_in_bytes #=> Float
|
965
1019
|
# resp.statistics.size.estimated_on #=> Time
|
966
1020
|
#
|
@@ -971,7 +1025,7 @@ module Aws::IoTAnalytics
|
|
971
1025
|
req.send_request(options)
|
972
1026
|
end
|
973
1027
|
|
974
|
-
# Retrieves information about a
|
1028
|
+
# Retrieves information about a dataset.
|
975
1029
|
#
|
976
1030
|
# @option params [required, String] :dataset_name
|
977
1031
|
# The name of the data set whose information is retrieved.
|
@@ -1025,6 +1079,9 @@ module Aws::IoTAnalytics
|
|
1025
1079
|
# resp.dataset.retention_period.number_of_days #=> Integer
|
1026
1080
|
# resp.dataset.versioning_configuration.unlimited #=> Boolean
|
1027
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
|
1028
1085
|
#
|
1029
1086
|
# @overload describe_dataset(params = {})
|
1030
1087
|
# @param [Hash] params ({})
|
@@ -1067,6 +1124,7 @@ module Aws::IoTAnalytics
|
|
1067
1124
|
# resp.datastore.retention_period.number_of_days #=> Integer
|
1068
1125
|
# resp.datastore.creation_time #=> Time
|
1069
1126
|
# resp.datastore.last_update_time #=> Time
|
1127
|
+
# resp.datastore.last_message_arrival_time #=> Time
|
1070
1128
|
# resp.statistics.size.estimated_size_in_bytes #=> Float
|
1071
1129
|
# resp.statistics.size.estimated_on #=> Time
|
1072
1130
|
#
|
@@ -1169,7 +1227,7 @@ module Aws::IoTAnalytics
|
|
1169
1227
|
req.send_request(options)
|
1170
1228
|
end
|
1171
1229
|
|
1172
|
-
# Retrieves the contents of a data set as
|
1230
|
+
# Retrieves the contents of a data set as presigned URIs.
|
1173
1231
|
#
|
1174
1232
|
# @option params [required, String] :dataset_name
|
1175
1233
|
# The name of the data set whose contents are retrieved.
|
@@ -1243,6 +1301,7 @@ module Aws::IoTAnalytics
|
|
1243
1301
|
# resp.channel_summaries[0].status #=> String, one of "CREATING", "ACTIVE", "DELETING"
|
1244
1302
|
# resp.channel_summaries[0].creation_time #=> Time
|
1245
1303
|
# resp.channel_summaries[0].last_update_time #=> Time
|
1304
|
+
# resp.channel_summaries[0].last_message_arrival_time #=> Time
|
1246
1305
|
# resp.next_token #=> String
|
1247
1306
|
#
|
1248
1307
|
# @overload list_channels(params = {})
|
@@ -1266,12 +1325,12 @@ module Aws::IoTAnalytics
|
|
1266
1325
|
# @option params [Time,DateTime,Date,Integer,String] :scheduled_on_or_after
|
1267
1326
|
# A filter to limit results to those data set contents whose creation is
|
1268
1327
|
# scheduled on or after the given time. See the field
|
1269
|
-
# `triggers.schedule` in the CreateDataset request. (timestamp)
|
1328
|
+
# `triggers.schedule` in the `CreateDataset` request. (timestamp)
|
1270
1329
|
#
|
1271
1330
|
# @option params [Time,DateTime,Date,Integer,String] :scheduled_before
|
1272
1331
|
# A filter to limit results to those data set contents whose creation is
|
1273
1332
|
# scheduled before the given time. See the field `triggers.schedule` in
|
1274
|
-
# the CreateDataset request. (timestamp)
|
1333
|
+
# the `CreateDataset` request. (timestamp)
|
1275
1334
|
#
|
1276
1335
|
# @return [Types::ListDatasetContentsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1277
1336
|
#
|
@@ -1388,6 +1447,7 @@ module Aws::IoTAnalytics
|
|
1388
1447
|
# resp.datastore_summaries[0].status #=> String, one of "CREATING", "ACTIVE", "DELETING"
|
1389
1448
|
# resp.datastore_summaries[0].creation_time #=> Time
|
1390
1449
|
# resp.datastore_summaries[0].last_update_time #=> Time
|
1450
|
+
# resp.datastore_summaries[0].last_message_arrival_time #=> Time
|
1391
1451
|
# resp.next_token #=> String
|
1392
1452
|
#
|
1393
1453
|
# @overload list_datastores(params = {})
|
@@ -1440,7 +1500,7 @@ module Aws::IoTAnalytics
|
|
1440
1500
|
req.send_request(options)
|
1441
1501
|
end
|
1442
1502
|
|
1443
|
-
# Lists the tags (metadata)
|
1503
|
+
# Lists the tags (metadata) that you have assigned to the resource.
|
1444
1504
|
#
|
1445
1505
|
# @option params [required, String] :resource_arn
|
1446
1506
|
# The ARN of the resource whose tags you want to list.
|
@@ -1470,11 +1530,11 @@ module Aws::IoTAnalytics
|
|
1470
1530
|
|
1471
1531
|
# Sets or updates the AWS IoT Analytics logging options.
|
1472
1532
|
#
|
1473
|
-
#
|
1474
|
-
#
|
1475
|
-
#
|
1476
|
-
#
|
1477
|
-
#
|
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.
|
1478
1538
|
#
|
1479
1539
|
# @option params [required, Types::LoggingOptions] :logging_options
|
1480
1540
|
# The new values of the AWS IoT Analytics logging options.
|
@@ -1502,14 +1562,14 @@ module Aws::IoTAnalytics
|
|
1502
1562
|
# payload.
|
1503
1563
|
#
|
1504
1564
|
# @option params [required, Types::PipelineActivity] :pipeline_activity
|
1505
|
-
# The pipeline activity that is run. This must not be a
|
1506
|
-
#
|
1507
|
-
#
|
1508
|
-
#
|
1509
|
-
#
|
1510
|
-
#
|
1511
|
-
#
|
1512
|
-
# @option params [required, Array<String,
|
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.
|
1571
|
+
#
|
1572
|
+
# @option params [required, Array<String, StringIO, File>] :payloads
|
1513
1573
|
# The sample message payloads on which the pipeline activity is run.
|
1514
1574
|
#
|
1515
1575
|
# @return [Types::RunPipelineActivityResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -1602,7 +1662,7 @@ module Aws::IoTAnalytics
|
|
1602
1662
|
# The name of the channel whose message samples are retrieved.
|
1603
1663
|
#
|
1604
1664
|
# @option params [Integer] :max_messages
|
1605
|
-
# 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
|
1606
1666
|
# default is also 10.
|
1607
1667
|
#
|
1608
1668
|
# @option params [Time,DateTime,Date,Integer,String] :start_time
|
@@ -1671,7 +1731,7 @@ module Aws::IoTAnalytics
|
|
1671
1731
|
end
|
1672
1732
|
|
1673
1733
|
# Adds to or modifies the tags of the given resource. Tags are metadata
|
1674
|
-
#
|
1734
|
+
# that can be used to manage a resource.
|
1675
1735
|
#
|
1676
1736
|
# @option params [required, String] :resource_arn
|
1677
1737
|
# The ARN of the resource whose tags you want to modify.
|
@@ -1730,10 +1790,10 @@ module Aws::IoTAnalytics
|
|
1730
1790
|
# The name of the channel to be updated.
|
1731
1791
|
#
|
1732
1792
|
# @option params [Types::ChannelStorage] :channel_storage
|
1733
|
-
# Where channel data is stored. You
|
1734
|
-
#
|
1735
|
-
#
|
1736
|
-
#
|
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.
|
1737
1797
|
#
|
1738
1798
|
# @option params [Types::RetentionPeriod] :retention_period
|
1739
1799
|
# How long, in days, message data is kept for the channel. The retention
|
@@ -1774,26 +1834,39 @@ module Aws::IoTAnalytics
|
|
1774
1834
|
# The name of the data set to update.
|
1775
1835
|
#
|
1776
1836
|
# @option params [required, Array<Types::DatasetAction>] :actions
|
1777
|
-
# A list of
|
1837
|
+
# A list of `DatasetAction` objects.
|
1778
1838
|
#
|
1779
1839
|
# @option params [Array<Types::DatasetTrigger>] :triggers
|
1780
|
-
# A list of
|
1781
|
-
# contain up to five
|
1840
|
+
# A list of `DatasetTrigger` objects. The list can be empty or can
|
1841
|
+
# contain up to five `DatasetTrigger` objects.
|
1782
1842
|
#
|
1783
1843
|
# @option params [Array<Types::DatasetContentDeliveryRule>] :content_delivery_rules
|
1784
|
-
# When
|
1844
|
+
# When dataset contents are created, they are delivered to destinations
|
1785
1845
|
# specified here.
|
1786
1846
|
#
|
1787
1847
|
# @option params [Types::RetentionPeriod] :retention_period
|
1788
|
-
# How long, in days,
|
1848
|
+
# How long, in days, dataset contents are kept for the dataset.
|
1789
1849
|
#
|
1790
1850
|
# @option params [Types::VersioningConfiguration] :versioning_configuration
|
1791
|
-
#
|
1851
|
+
# Optional. How many versions of dataset contents are kept. If not
|
1792
1852
|
# specified or set to null, only the latest version plus the latest
|
1793
1853
|
# succeeded version (if they are different) are kept for the time period
|
1794
|
-
# specified by the
|
1795
|
-
# see
|
1796
|
-
#
|
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
|
1797
1870
|
#
|
1798
1871
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1799
1872
|
#
|
@@ -1876,6 +1949,16 @@ module Aws::IoTAnalytics
|
|
1876
1949
|
# unlimited: false,
|
1877
1950
|
# max_versions: 1,
|
1878
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
|
+
# ],
|
1879
1962
|
# })
|
1880
1963
|
#
|
1881
1964
|
# @overload update_dataset(params = {})
|
@@ -1896,10 +1979,10 @@ module Aws::IoTAnalytics
|
|
1896
1979
|
# customer-managed.
|
1897
1980
|
#
|
1898
1981
|
# @option params [Types::DatastoreStorage] :datastore_storage
|
1899
|
-
# Where data store data is stored. You
|
1900
|
-
#
|
1901
|
-
#
|
1902
|
-
# 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.
|
1903
1986
|
#
|
1904
1987
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1905
1988
|
#
|
@@ -1937,15 +2020,15 @@ module Aws::IoTAnalytics
|
|
1937
2020
|
# The name of the pipeline to update.
|
1938
2021
|
#
|
1939
2022
|
# @option params [required, Array<Types::PipelineActivity>] :pipeline_activities
|
1940
|
-
# A list of
|
2023
|
+
# A list of `PipelineActivity` objects. Activities perform
|
1941
2024
|
# transformations on your messages, such as removing, renaming or adding
|
1942
2025
|
# message attributes; filtering messages based on attribute values;
|
1943
2026
|
# invoking your Lambda functions on messages for advanced processing; or
|
1944
2027
|
# performing mathematical transformations to normalize device data.
|
1945
2028
|
#
|
1946
|
-
# The list can be 2-25
|
1947
|
-
#
|
1948
|
-
#
|
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:
|
1949
2032
|
#
|
1950
2033
|
# `pipelineActivities = [ \{ "channel": \{ ... \} \}, \{ "lambda": \{
|
1951
2034
|
# ... \} \}, ... ]`
|
@@ -2039,7 +2122,7 @@ module Aws::IoTAnalytics
|
|
2039
2122
|
params: params,
|
2040
2123
|
config: config)
|
2041
2124
|
context[:gem_name] = 'aws-sdk-iotanalytics'
|
2042
|
-
context[:gem_version] = '1.
|
2125
|
+
context[:gem_version] = '1.35.0'
|
2043
2126
|
Seahorse::Client::Request.new(handlers, context)
|
2044
2127
|
end
|
2045
2128
|
|