aws-sdk-iotanalytics 1.31.0 → 1.36.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 +3 -2
- data/lib/aws-sdk-iotanalytics/client.rb +251 -98
- 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: '08174bbfc26b1c312d446dcc4be7890ee7c07b7eff94d0bfd2eca8b16f3943ed'
|
4
|
+
data.tar.gz: d6b73229344f547730f4a083f8e604c8aba5d94f84892694bad9a0f605aa571d
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 3f26c80fc1a352e324d0ba8cb224054a07e47a8be9f02c13c4d4961619ab39645fe7aa8f4fc47fd2ebb79fb3fa4b3c9f1664ab73ae5375df8e8e0bcce8277939
|
7
|
+
data.tar.gz: b8191fb25ebca6377a2990d1df89eb0819f2264ce930e9b4bf23f07a9c74c9ad96cd4f4858f8db0c237e64f01c07453fc45b60f2f3c79a1bfe98b0feb4f8e20c
|
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
|
|
@@ -44,9 +45,9 @@ require_relative 'aws-sdk-iotanalytics/customizations'
|
|
44
45
|
#
|
45
46
|
# See {Errors} for more information.
|
46
47
|
#
|
47
|
-
#
|
48
|
+
# @!group service
|
48
49
|
module Aws::IoTAnalytics
|
49
50
|
|
50
|
-
GEM_VERSION = '1.
|
51
|
+
GEM_VERSION = '1.36.0'
|
51
52
|
|
52
53
|
end
|
@@ -85,13 +85,28 @@ module Aws::IoTAnalytics
|
|
85
85
|
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
86
86
|
# credentials.
|
87
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
|
+
#
|
88
102
|
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
|
89
103
|
# from an EC2 IMDS on an EC2 instance.
|
90
104
|
#
|
91
|
-
# * `Aws::
|
92
|
-
#
|
105
|
+
# * `Aws::ECSCredentials` - Used for loading credentials from
|
106
|
+
# instances running in ECS.
|
93
107
|
#
|
94
|
-
# * `Aws::
|
108
|
+
# * `Aws::CognitoIdentityCredentials` - Used for loading credentials
|
109
|
+
# from the Cognito Identity service.
|
95
110
|
#
|
96
111
|
# When `:credentials` are not configured directly, the following
|
97
112
|
# locations will be searched for credentials:
|
@@ -101,10 +116,10 @@ module Aws::IoTAnalytics
|
|
101
116
|
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
|
102
117
|
# * `~/.aws/credentials`
|
103
118
|
# * `~/.aws/config`
|
104
|
-
# * EC2 IMDS instance profile - When used by default, the timeouts
|
105
|
-
# very aggressive. Construct and pass an instance of
|
106
|
-
# `Aws::InstanceProfileCredentails`
|
107
|
-
# 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.
|
108
123
|
#
|
109
124
|
# @option options [required, String] :region
|
110
125
|
# The AWS region to connect to. The configured `:region` is
|
@@ -318,13 +333,13 @@ module Aws::IoTAnalytics
|
|
318
333
|
# The name of the channel where the messages are sent.
|
319
334
|
#
|
320
335
|
# @option params [required, Array<Types::Message>] :messages
|
321
|
-
# The list of messages to be sent. Each message has format:
|
322
|
-
# "messageId": "string", "payload": "string"\\}
|
336
|
+
# The list of messages to be sent. Each message has the format: \\\{
|
337
|
+
# "messageId": "string", "payload": "string"\\}.
|
323
338
|
#
|
324
|
-
#
|
325
|
-
#
|
339
|
+
# The field names of message payloads (data) that you send to AWS IoT
|
340
|
+
# Analytics:
|
326
341
|
#
|
327
|
-
# * Must contain only alphanumeric characters and undescores (\_)
|
342
|
+
# * Must contain only alphanumeric characters and undescores (\_). No
|
328
343
|
# other special characters are allowed.
|
329
344
|
#
|
330
345
|
# * Must begin with an alphabetic character or single underscore (\_).
|
@@ -334,10 +349,10 @@ module Aws::IoTAnalytics
|
|
334
349
|
# * In regular expression terms:
|
335
350
|
# "^\[A-Za-z\_\](\[A-Za-z0-9\]*\|\[A-Za-z0-9\]\[A-Za-z0-9\_\]*)$".
|
336
351
|
#
|
337
|
-
# * Cannot be
|
352
|
+
# * Cannot be more than 255 characters.
|
338
353
|
#
|
339
|
-
# * Are case
|
340
|
-
#
|
354
|
+
# * Are case insensitive. (Fields named foo and FOO in the same payload
|
355
|
+
# are considered duplicates.)
|
341
356
|
#
|
342
357
|
# For example, \\\{"temp\_01": 29\\} or \\\{"\_temp\_01": 29\\} are
|
343
358
|
# valid, but \\\{"temp-01": 29\\}, \\\{"01\_temp": 29\\} or
|
@@ -380,7 +395,7 @@ module Aws::IoTAnalytics
|
|
380
395
|
#
|
381
396
|
# @option params [required, String] :reprocessing_id
|
382
397
|
# The ID of the reprocessing task (returned by
|
383
|
-
#
|
398
|
+
# `StartPipelineReprocessing`).
|
384
399
|
#
|
385
400
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
386
401
|
#
|
@@ -406,14 +421,14 @@ module Aws::IoTAnalytics
|
|
406
421
|
# The name of the channel.
|
407
422
|
#
|
408
423
|
# @option params [Types::ChannelStorage] :channel_storage
|
409
|
-
# Where channel data is stored. You
|
410
|
-
#
|
411
|
-
#
|
412
|
-
#
|
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.
|
413
428
|
#
|
414
429
|
# @option params [Types::RetentionPeriod] :retention_period
|
415
430
|
# How long, in days, message data is kept for the channel. When
|
416
|
-
#
|
431
|
+
# `customerManagedS3` storage is selected, this parameter is ignored.
|
417
432
|
#
|
418
433
|
# @option params [Array<Types::Tag>] :tags
|
419
434
|
# Metadata which can be used to manage the channel.
|
@@ -463,12 +478,12 @@ module Aws::IoTAnalytics
|
|
463
478
|
req.send_request(options)
|
464
479
|
end
|
465
480
|
|
466
|
-
# Creates a
|
467
|
-
# 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`
|
468
483
|
# (executing a containerized application). This operation creates the
|
469
|
-
# skeleton of a
|
470
|
-
# calling
|
471
|
-
#
|
484
|
+
# skeleton of a dataset. The dataset can be populated manually by
|
485
|
+
# calling `CreateDatasetContent` or automatically according to a trigger
|
486
|
+
# you specify.
|
472
487
|
#
|
473
488
|
# @option params [required, String] :dataset_name
|
474
489
|
# The name of the data set.
|
@@ -480,31 +495,49 @@ module Aws::IoTAnalytics
|
|
480
495
|
# A list of triggers. A trigger causes data set contents to be populated
|
481
496
|
# at a specified time interval or when another data set's contents are
|
482
497
|
# created. The list of triggers can be empty or contain up to five
|
483
|
-
#
|
498
|
+
# `DataSetTrigger` objects.
|
484
499
|
#
|
485
500
|
# @option params [Array<Types::DatasetContentDeliveryRule>] :content_delivery_rules
|
486
|
-
# When
|
501
|
+
# When dataset contents are created, they are delivered to destinations
|
487
502
|
# specified here.
|
488
503
|
#
|
489
504
|
# @option params [Types::RetentionPeriod] :retention_period
|
490
|
-
#
|
491
|
-
#
|
492
|
-
#
|
493
|
-
#
|
494
|
-
# `versioningConfiguration` parameter.
|
495
|
-
#
|
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
|
496
516
|
#
|
497
517
|
# @option params [Types::VersioningConfiguration] :versioning_configuration
|
498
|
-
#
|
518
|
+
# Optional. How many versions of dataset contents are kept. If not
|
499
519
|
# specified or set to null, only the latest version plus the latest
|
500
520
|
# succeeded version (if they are different) are kept for the time period
|
501
|
-
# specified by the
|
502
|
-
# see
|
503
|
-
#
|
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
|
504
528
|
#
|
505
529
|
# @option params [Array<Types::Tag>] :tags
|
506
530
|
# Metadata which can be used to manage the data set.
|
507
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
|
+
#
|
508
541
|
# @return [Types::CreateDatasetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
509
542
|
#
|
510
543
|
# * {Types::CreateDatasetResponse#dataset_name #dataset_name} => String
|
@@ -596,6 +629,16 @@ module Aws::IoTAnalytics
|
|
596
629
|
# value: "TagValue", # required
|
597
630
|
# },
|
598
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
|
+
# ],
|
599
642
|
# })
|
600
643
|
#
|
601
644
|
# @example Response structure
|
@@ -612,12 +655,19 @@ module Aws::IoTAnalytics
|
|
612
655
|
req.send_request(options)
|
613
656
|
end
|
614
657
|
|
615
|
-
# Creates the content of a data set by applying a
|
616
|
-
# query) or a
|
617
|
-
# application).
|
658
|
+
# Creates the content of a data set by applying a `queryAction` (a SQL
|
659
|
+
# query) or a `containerAction` (executing a containerized application).
|
618
660
|
#
|
619
661
|
# @option params [required, String] :dataset_name
|
620
|
-
# 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
|
621
671
|
#
|
622
672
|
# @return [Types::CreateDatasetContentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
623
673
|
#
|
@@ -627,6 +677,7 @@ module Aws::IoTAnalytics
|
|
627
677
|
#
|
628
678
|
# resp = client.create_dataset_content({
|
629
679
|
# dataset_name: "DatasetName", # required
|
680
|
+
# version_id: "DatasetContentVersion",
|
630
681
|
# })
|
631
682
|
#
|
632
683
|
# @example Response structure
|
@@ -646,18 +697,30 @@ module Aws::IoTAnalytics
|
|
646
697
|
# The name of the data store.
|
647
698
|
#
|
648
699
|
# @option params [Types::DatastoreStorage] :datastore_storage
|
649
|
-
# Where data store data is stored. You
|
650
|
-
#
|
651
|
-
#
|
652
|
-
# 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.
|
653
704
|
#
|
654
705
|
# @option params [Types::RetentionPeriod] :retention_period
|
655
706
|
# How long, in days, message data is kept for the data store. When
|
656
|
-
#
|
707
|
+
# `customerManagedS3` storage is selected, this parameter is ignored.
|
657
708
|
#
|
658
709
|
# @option params [Array<Types::Tag>] :tags
|
659
710
|
# Metadata which can be used to manage the data store.
|
660
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
|
+
#
|
661
724
|
# @return [Types::CreateDatastoreResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
662
725
|
#
|
663
726
|
# * {Types::CreateDatastoreResponse#datastore_name #datastore_name} => String
|
@@ -687,6 +750,20 @@ module Aws::IoTAnalytics
|
|
687
750
|
# value: "TagValue", # required
|
688
751
|
# },
|
689
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
|
+
# },
|
690
767
|
# })
|
691
768
|
#
|
692
769
|
# @example Response structure
|
@@ -713,15 +790,15 @@ module Aws::IoTAnalytics
|
|
713
790
|
# The name of the pipeline.
|
714
791
|
#
|
715
792
|
# @option params [required, Array<Types::PipelineActivity>] :pipeline_activities
|
716
|
-
# A list of
|
793
|
+
# A list of `PipelineActivity` objects. Activities perform
|
717
794
|
# transformations on your messages, such as removing, renaming or adding
|
718
795
|
# message attributes; filtering messages based on attribute values;
|
719
796
|
# invoking your Lambda functions on messages for advanced processing; or
|
720
797
|
# performing mathematical transformations to normalize device data.
|
721
798
|
#
|
722
|
-
# The list can be 2-25
|
723
|
-
#
|
724
|
-
#
|
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:
|
725
802
|
#
|
726
803
|
# `pipelineActivities = [ \{ "channel": \{ ... \} \}, \{ "lambda": \{
|
727
804
|
# ... \} \}, ... ]`
|
@@ -839,9 +916,9 @@ module Aws::IoTAnalytics
|
|
839
916
|
req.send_request(options)
|
840
917
|
end
|
841
918
|
|
842
|
-
# Deletes the specified
|
919
|
+
# Deletes the specified dataset.
|
843
920
|
#
|
844
|
-
# You do not have to delete the content of the
|
921
|
+
# You do not have to delete the content of the dataset before you
|
845
922
|
# perform this operation.
|
846
923
|
#
|
847
924
|
# @option params [required, String] :dataset_name
|
@@ -862,13 +939,13 @@ module Aws::IoTAnalytics
|
|
862
939
|
req.send_request(options)
|
863
940
|
end
|
864
941
|
|
865
|
-
# Deletes the content of the specified
|
942
|
+
# Deletes the content of the specified dataset.
|
866
943
|
#
|
867
944
|
# @option params [required, String] :dataset_name
|
868
|
-
# The name of the
|
945
|
+
# The name of the dataset whose content is deleted.
|
869
946
|
#
|
870
947
|
# @option params [String] :version_id
|
871
|
-
# The version of the
|
948
|
+
# The version of the dataset whose content is deleted. You can also use
|
872
949
|
# the strings "$LATEST" or "$LATEST\_SUCCEEDED" to delete the latest
|
873
950
|
# or latest successfully completed data set. If not specified,
|
874
951
|
# "$LATEST\_SUCCEEDED" is the default.
|
@@ -963,6 +1040,7 @@ module Aws::IoTAnalytics
|
|
963
1040
|
# resp.channel.retention_period.number_of_days #=> Integer
|
964
1041
|
# resp.channel.creation_time #=> Time
|
965
1042
|
# resp.channel.last_update_time #=> Time
|
1043
|
+
# resp.channel.last_message_arrival_time #=> Time
|
966
1044
|
# resp.statistics.size.estimated_size_in_bytes #=> Float
|
967
1045
|
# resp.statistics.size.estimated_on #=> Time
|
968
1046
|
#
|
@@ -973,7 +1051,7 @@ module Aws::IoTAnalytics
|
|
973
1051
|
req.send_request(options)
|
974
1052
|
end
|
975
1053
|
|
976
|
-
# Retrieves information about a
|
1054
|
+
# Retrieves information about a dataset.
|
977
1055
|
#
|
978
1056
|
# @option params [required, String] :dataset_name
|
979
1057
|
# The name of the data set whose information is retrieved.
|
@@ -1027,6 +1105,9 @@ module Aws::IoTAnalytics
|
|
1027
1105
|
# resp.dataset.retention_period.number_of_days #=> Integer
|
1028
1106
|
# resp.dataset.versioning_configuration.unlimited #=> Boolean
|
1029
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
|
1030
1111
|
#
|
1031
1112
|
# @overload describe_dataset(params = {})
|
1032
1113
|
# @param [Hash] params ({})
|
@@ -1069,6 +1150,10 @@ module Aws::IoTAnalytics
|
|
1069
1150
|
# resp.datastore.retention_period.number_of_days #=> Integer
|
1070
1151
|
# resp.datastore.creation_time #=> Time
|
1071
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
|
1072
1157
|
# resp.statistics.size.estimated_size_in_bytes #=> Float
|
1073
1158
|
# resp.statistics.size.estimated_on #=> Time
|
1074
1159
|
#
|
@@ -1171,7 +1256,7 @@ module Aws::IoTAnalytics
|
|
1171
1256
|
req.send_request(options)
|
1172
1257
|
end
|
1173
1258
|
|
1174
|
-
# Retrieves the contents of a data set as
|
1259
|
+
# Retrieves the contents of a data set as presigned URIs.
|
1175
1260
|
#
|
1176
1261
|
# @option params [required, String] :dataset_name
|
1177
1262
|
# The name of the data set whose contents are retrieved.
|
@@ -1245,6 +1330,7 @@ module Aws::IoTAnalytics
|
|
1245
1330
|
# resp.channel_summaries[0].status #=> String, one of "CREATING", "ACTIVE", "DELETING"
|
1246
1331
|
# resp.channel_summaries[0].creation_time #=> Time
|
1247
1332
|
# resp.channel_summaries[0].last_update_time #=> Time
|
1333
|
+
# resp.channel_summaries[0].last_message_arrival_time #=> Time
|
1248
1334
|
# resp.next_token #=> String
|
1249
1335
|
#
|
1250
1336
|
# @overload list_channels(params = {})
|
@@ -1268,12 +1354,12 @@ module Aws::IoTAnalytics
|
|
1268
1354
|
# @option params [Time,DateTime,Date,Integer,String] :scheduled_on_or_after
|
1269
1355
|
# A filter to limit results to those data set contents whose creation is
|
1270
1356
|
# scheduled on or after the given time. See the field
|
1271
|
-
# `triggers.schedule` in the CreateDataset request. (timestamp)
|
1357
|
+
# `triggers.schedule` in the `CreateDataset` request. (timestamp)
|
1272
1358
|
#
|
1273
1359
|
# @option params [Time,DateTime,Date,Integer,String] :scheduled_before
|
1274
1360
|
# A filter to limit results to those data set contents whose creation is
|
1275
1361
|
# scheduled before the given time. See the field `triggers.schedule` in
|
1276
|
-
# the CreateDataset request. (timestamp)
|
1362
|
+
# the `CreateDataset` request. (timestamp)
|
1277
1363
|
#
|
1278
1364
|
# @return [Types::ListDatasetContentsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1279
1365
|
#
|
@@ -1390,6 +1476,8 @@ module Aws::IoTAnalytics
|
|
1390
1476
|
# resp.datastore_summaries[0].status #=> String, one of "CREATING", "ACTIVE", "DELETING"
|
1391
1477
|
# resp.datastore_summaries[0].creation_time #=> Time
|
1392
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"
|
1393
1481
|
# resp.next_token #=> String
|
1394
1482
|
#
|
1395
1483
|
# @overload list_datastores(params = {})
|
@@ -1442,7 +1530,7 @@ module Aws::IoTAnalytics
|
|
1442
1530
|
req.send_request(options)
|
1443
1531
|
end
|
1444
1532
|
|
1445
|
-
# Lists the tags (metadata)
|
1533
|
+
# Lists the tags (metadata) that you have assigned to the resource.
|
1446
1534
|
#
|
1447
1535
|
# @option params [required, String] :resource_arn
|
1448
1536
|
# The ARN of the resource whose tags you want to list.
|
@@ -1472,11 +1560,11 @@ module Aws::IoTAnalytics
|
|
1472
1560
|
|
1473
1561
|
# Sets or updates the AWS IoT Analytics logging options.
|
1474
1562
|
#
|
1475
|
-
#
|
1476
|
-
#
|
1477
|
-
#
|
1478
|
-
#
|
1479
|
-
#
|
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.
|
1480
1568
|
#
|
1481
1569
|
# @option params [required, Types::LoggingOptions] :logging_options
|
1482
1570
|
# The new values of the AWS IoT Analytics logging options.
|
@@ -1504,14 +1592,14 @@ module Aws::IoTAnalytics
|
|
1504
1592
|
# payload.
|
1505
1593
|
#
|
1506
1594
|
# @option params [required, Types::PipelineActivity] :pipeline_activity
|
1507
|
-
# The pipeline activity that is run. This must not be a
|
1508
|
-
#
|
1509
|
-
#
|
1510
|
-
#
|
1511
|
-
#
|
1512
|
-
#
|
1513
|
-
#
|
1514
|
-
# @option params [required, Array<String,
|
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.
|
1601
|
+
#
|
1602
|
+
# @option params [required, Array<String, StringIO, File>] :payloads
|
1515
1603
|
# The sample message payloads on which the pipeline activity is run.
|
1516
1604
|
#
|
1517
1605
|
# @return [Types::RunPipelineActivityResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -1604,7 +1692,7 @@ module Aws::IoTAnalytics
|
|
1604
1692
|
# The name of the channel whose message samples are retrieved.
|
1605
1693
|
#
|
1606
1694
|
# @option params [Integer] :max_messages
|
1607
|
-
# 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
|
1608
1696
|
# default is also 10.
|
1609
1697
|
#
|
1610
1698
|
# @option params [Time,DateTime,Date,Integer,String] :start_time
|
@@ -1646,9 +1734,22 @@ module Aws::IoTAnalytics
|
|
1646
1734
|
# @option params [Time,DateTime,Date,Integer,String] :start_time
|
1647
1735
|
# The start time (inclusive) of raw message data that is reprocessed.
|
1648
1736
|
#
|
1737
|
+
# If you specify a value for the `startTime` parameter, you must not use
|
1738
|
+
# the `channelMessages` object.
|
1739
|
+
#
|
1649
1740
|
# @option params [Time,DateTime,Date,Integer,String] :end_time
|
1650
1741
|
# The end time (exclusive) of raw message data that is reprocessed.
|
1651
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
|
+
#
|
1652
1753
|
# @return [Types::StartPipelineReprocessingResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1653
1754
|
#
|
1654
1755
|
# * {Types::StartPipelineReprocessingResponse#reprocessing_id #reprocessing_id} => String
|
@@ -1659,6 +1760,9 @@ module Aws::IoTAnalytics
|
|
1659
1760
|
# pipeline_name: "PipelineName", # required
|
1660
1761
|
# start_time: Time.now,
|
1661
1762
|
# end_time: Time.now,
|
1763
|
+
# channel_messages: {
|
1764
|
+
# s3_paths: ["S3PathChannelMessage"],
|
1765
|
+
# },
|
1662
1766
|
# })
|
1663
1767
|
#
|
1664
1768
|
# @example Response structure
|
@@ -1673,7 +1777,7 @@ module Aws::IoTAnalytics
|
|
1673
1777
|
end
|
1674
1778
|
|
1675
1779
|
# Adds to or modifies the tags of the given resource. Tags are metadata
|
1676
|
-
#
|
1780
|
+
# that can be used to manage a resource.
|
1677
1781
|
#
|
1678
1782
|
# @option params [required, String] :resource_arn
|
1679
1783
|
# The ARN of the resource whose tags you want to modify.
|
@@ -1732,10 +1836,10 @@ module Aws::IoTAnalytics
|
|
1732
1836
|
# The name of the channel to be updated.
|
1733
1837
|
#
|
1734
1838
|
# @option params [Types::ChannelStorage] :channel_storage
|
1735
|
-
# Where channel data is stored. You
|
1736
|
-
#
|
1737
|
-
#
|
1738
|
-
#
|
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.
|
1739
1843
|
#
|
1740
1844
|
# @option params [Types::RetentionPeriod] :retention_period
|
1741
1845
|
# How long, in days, message data is kept for the channel. The retention
|
@@ -1776,26 +1880,39 @@ module Aws::IoTAnalytics
|
|
1776
1880
|
# The name of the data set to update.
|
1777
1881
|
#
|
1778
1882
|
# @option params [required, Array<Types::DatasetAction>] :actions
|
1779
|
-
# A list of
|
1883
|
+
# A list of `DatasetAction` objects.
|
1780
1884
|
#
|
1781
1885
|
# @option params [Array<Types::DatasetTrigger>] :triggers
|
1782
|
-
# A list of
|
1783
|
-
# contain up to five
|
1886
|
+
# A list of `DatasetTrigger` objects. The list can be empty or can
|
1887
|
+
# contain up to five `DatasetTrigger` objects.
|
1784
1888
|
#
|
1785
1889
|
# @option params [Array<Types::DatasetContentDeliveryRule>] :content_delivery_rules
|
1786
|
-
# When
|
1890
|
+
# When dataset contents are created, they are delivered to destinations
|
1787
1891
|
# specified here.
|
1788
1892
|
#
|
1789
1893
|
# @option params [Types::RetentionPeriod] :retention_period
|
1790
|
-
# How long, in days,
|
1894
|
+
# How long, in days, dataset contents are kept for the dataset.
|
1791
1895
|
#
|
1792
1896
|
# @option params [Types::VersioningConfiguration] :versioning_configuration
|
1793
|
-
#
|
1897
|
+
# Optional. How many versions of dataset contents are kept. If not
|
1794
1898
|
# specified or set to null, only the latest version plus the latest
|
1795
1899
|
# succeeded version (if they are different) are kept for the time period
|
1796
|
-
# specified by the
|
1797
|
-
# see
|
1798
|
-
#
|
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
|
1799
1916
|
#
|
1800
1917
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1801
1918
|
#
|
@@ -1878,6 +1995,16 @@ module Aws::IoTAnalytics
|
|
1878
1995
|
# unlimited: false,
|
1879
1996
|
# max_versions: 1,
|
1880
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
|
+
# ],
|
1881
2008
|
# })
|
1882
2009
|
#
|
1883
2010
|
# @overload update_dataset(params = {})
|
@@ -1898,10 +2025,22 @@ module Aws::IoTAnalytics
|
|
1898
2025
|
# customer-managed.
|
1899
2026
|
#
|
1900
2027
|
# @option params [Types::DatastoreStorage] :datastore_storage
|
1901
|
-
# Where data store data is stored. You
|
1902
|
-
#
|
1903
|
-
#
|
1904
|
-
# 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/
|
1905
2044
|
#
|
1906
2045
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1907
2046
|
#
|
@@ -1922,6 +2061,20 @@ module Aws::IoTAnalytics
|
|
1922
2061
|
# role_arn: "RoleArn", # required
|
1923
2062
|
# },
|
1924
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
|
+
# },
|
1925
2078
|
# })
|
1926
2079
|
#
|
1927
2080
|
# @overload update_datastore(params = {})
|
@@ -1939,15 +2092,15 @@ module Aws::IoTAnalytics
|
|
1939
2092
|
# The name of the pipeline to update.
|
1940
2093
|
#
|
1941
2094
|
# @option params [required, Array<Types::PipelineActivity>] :pipeline_activities
|
1942
|
-
# A list of
|
2095
|
+
# A list of `PipelineActivity` objects. Activities perform
|
1943
2096
|
# transformations on your messages, such as removing, renaming or adding
|
1944
2097
|
# message attributes; filtering messages based on attribute values;
|
1945
2098
|
# invoking your Lambda functions on messages for advanced processing; or
|
1946
2099
|
# performing mathematical transformations to normalize device data.
|
1947
2100
|
#
|
1948
|
-
# The list can be 2-25
|
1949
|
-
#
|
1950
|
-
#
|
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:
|
1951
2104
|
#
|
1952
2105
|
# `pipelineActivities = [ \{ "channel": \{ ... \} \}, \{ "lambda": \{
|
1953
2106
|
# ... \} \}, ... ]`
|
@@ -2041,7 +2194,7 @@ module Aws::IoTAnalytics
|
|
2041
2194
|
params: params,
|
2042
2195
|
config: config)
|
2043
2196
|
context[:gem_name] = 'aws-sdk-iotanalytics'
|
2044
|
-
context[:gem_version] = '1.
|
2197
|
+
context[:gem_version] = '1.36.0'
|
2045
2198
|
Seahorse::Client::Request.new(handlers, context)
|
2046
2199
|
end
|
2047
2200
|
|