aws-sdk-iotanalytics 1.24.0 → 1.29.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
- SHA1:
3
- metadata.gz: f4f988f56056f7fcfc11dc4b68e33a7a6453a551
4
- data.tar.gz: 478b411526f7b15deb6d83658a6d9650966bd8ad
2
+ SHA256:
3
+ metadata.gz: 002a544c5a5fe65a94c130e27f868432fd1e62924538ab1170be859e7a757027
4
+ data.tar.gz: 9fb13f88efb5c024540cec52832efdaa004c8da3ee59c77060c757ad094a47bd
5
5
  SHA512:
6
- metadata.gz: 427b2374e0ccf2b61467bd146d4551001979360a38e7d8c1fdc39733d8506039b1c840e34ec23812d5f8fea9af18488af28329691caad7301240deea6287b4ed
7
- data.tar.gz: 86b0ea7cb5ca475f60af3659bbf961c9fe8b638291944c7986fe5e2b1ed4925a5eb4e678192fdbf88ac9009f1691d99ef0a24ea95e936c31b867eb2cda761a20
6
+ metadata.gz: 270db676a14cf086c4cb4c9d5c11204bf59a4c555afe57ce656c7f0987bca3a9da91fd03c5bd7ee1028b39ed16dfd94f6167acde840728a249bfbb0bde8a2927
7
+ data.tar.gz: 75eb16e54e689ec5f4a536bb495810529287a696e39d318e07392f1133383631cdc83c564cd507bee7f4fcc2a3dca6897bfc348710fdd819405b17788f912d79
@@ -24,17 +24,20 @@ require_relative 'aws-sdk-iotanalytics/customizations'
24
24
  # methods each accept a hash of request parameters and return a response
25
25
  # structure.
26
26
  #
27
+ # io_t_analytics = Aws::IoTAnalytics::Client.new
28
+ # resp = io_t_analytics.batch_put_message(params)
29
+ #
27
30
  # See {Client} for more information.
28
31
  #
29
32
  # # Errors
30
33
  #
31
- # Errors returned from AWS IoT Analytics all
32
- # extend {Errors::ServiceError}.
34
+ # Errors returned from AWS IoT Analytics are defined in the
35
+ # {Errors} module and all extend {Errors::ServiceError}.
33
36
  #
34
37
  # begin
35
38
  # # do stuff
36
39
  # rescue Aws::IoTAnalytics::Errors::ServiceError
37
- # # rescues all service API errors
40
+ # # rescues all AWS IoT Analytics API errors
38
41
  # end
39
42
  #
40
43
  # See {Errors} for more information.
@@ -42,6 +45,6 @@ require_relative 'aws-sdk-iotanalytics/customizations'
42
45
  # @service
43
46
  module Aws::IoTAnalytics
44
47
 
45
- GEM_VERSION = '1.24.0'
48
+ GEM_VERSION = '1.29.0'
46
49
 
47
50
  end
@@ -30,6 +30,18 @@ require 'aws-sdk-core/plugins/protocols/rest_json.rb'
30
30
  Aws::Plugins::GlobalConfiguration.add_identifier(:iotanalytics)
31
31
 
32
32
  module Aws::IoTAnalytics
33
+ # An API client for IoTAnalytics. To construct a client, you need to configure a `:region` and `:credentials`.
34
+ #
35
+ # client = Aws::IoTAnalytics::Client.new(
36
+ # region: region_name,
37
+ # credentials: credentials,
38
+ # # ...
39
+ # )
40
+ #
41
+ # For details on configuring region and credentials see
42
+ # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
43
+ #
44
+ # See {#initialize} for a full list of supported configuration options.
33
45
  class Client < Seahorse::Client::Base
34
46
 
35
47
  include Aws::ClientStubs
@@ -93,7 +105,7 @@ module Aws::IoTAnalytics
93
105
  # @option options [required, String] :region
94
106
  # The AWS region to connect to. The configured `:region` is
95
107
  # used to determine the service `:endpoint`. When not passed,
96
- # a default `:region` is search for in the following locations:
108
+ # a default `:region` is searched for in the following locations:
97
109
  #
98
110
  # * `Aws.config[:region]`
99
111
  # * `ENV['AWS_REGION']`
@@ -108,6 +120,12 @@ module Aws::IoTAnalytics
108
120
  # When set to `true`, a thread polling for endpoints will be running in
109
121
  # the background every 60 secs (default). Defaults to `false`.
110
122
  #
123
+ # @option options [Boolean] :adaptive_retry_wait_to_fill (true)
124
+ # Used only in `adaptive` retry mode. When true, the request will sleep
125
+ # until there is sufficent client side capacity to retry the request.
126
+ # When false, the request will raise a `RetryCapacityNotAvailableError` and will
127
+ # not retry instead of sleeping.
128
+ #
111
129
  # @option options [Boolean] :client_side_monitoring (false)
112
130
  # When `true`, client-side metrics will be collected for all API requests from
113
131
  # this client.
@@ -132,6 +150,10 @@ module Aws::IoTAnalytics
132
150
  # When `true`, an attempt is made to coerce request parameters into
133
151
  # the required types.
134
152
  #
153
+ # @option options [Boolean] :correct_clock_skew (true)
154
+ # Used only in `standard` and adaptive retry modes. Specifies whether to apply
155
+ # a clock skew correction and retry requests with skewed client clocks.
156
+ #
135
157
  # @option options [Boolean] :disable_host_prefix_injection (false)
136
158
  # Set to true to disable SDK automatically adding host prefix
137
159
  # to default service endpoint when available.
@@ -139,7 +161,7 @@ module Aws::IoTAnalytics
139
161
  # @option options [String] :endpoint
140
162
  # The client endpoint is normally constructed from the `:region`
141
163
  # option. You should only configure an `:endpoint` when connecting
142
- # to test endpoints. This should be avalid HTTP(S) URI.
164
+ # to test endpoints. This should be a valid HTTP(S) URI.
143
165
  #
144
166
  # @option options [Integer] :endpoint_cache_max_entries (1000)
145
167
  # Used for the maximum size limit of the LRU cache storing endpoints data
@@ -154,7 +176,7 @@ module Aws::IoTAnalytics
154
176
  # requests fetching endpoints information. Defaults to 60 sec.
155
177
  #
156
178
  # @option options [Boolean] :endpoint_discovery (false)
157
- # When set to `true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.
179
+ # When set to `true`, endpoint discovery will be enabled for operations when available.
158
180
  #
159
181
  # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
160
182
  # The log formatter.
@@ -166,15 +188,29 @@ module Aws::IoTAnalytics
166
188
  # The Logger instance to send log messages to. If this option
167
189
  # is not set, logging will be disabled.
168
190
  #
191
+ # @option options [Integer] :max_attempts (3)
192
+ # An integer representing the maximum number attempts that will be made for
193
+ # a single request, including the initial attempt. For example,
194
+ # setting this value to 5 will result in a request being retried up to
195
+ # 4 times. Used in `standard` and `adaptive` retry modes.
196
+ #
169
197
  # @option options [String] :profile ("default")
170
198
  # Used when loading credentials from the shared credentials file
171
199
  # at HOME/.aws/credentials. When not specified, 'default' is used.
172
200
  #
201
+ # @option options [Proc] :retry_backoff
202
+ # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
203
+ # This option is only used in the `legacy` retry mode.
204
+ #
173
205
  # @option options [Float] :retry_base_delay (0.3)
174
- # The base delay in seconds used by the default backoff function.
206
+ # The base delay in seconds used by the default backoff function. This option
207
+ # is only used in the `legacy` retry mode.
175
208
  #
176
209
  # @option options [Symbol] :retry_jitter (:none)
177
- # A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number.
210
+ # A delay randomiser function used by the default backoff function.
211
+ # Some predefined functions can be referenced by name - :none, :equal, :full,
212
+ # otherwise a Proc that takes and returns a number. This option is only used
213
+ # in the `legacy` retry mode.
178
214
  #
179
215
  # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
180
216
  #
@@ -182,11 +218,30 @@ module Aws::IoTAnalytics
182
218
  # The maximum number of times to retry failed requests. Only
183
219
  # ~ 500 level server errors and certain ~ 400 level client errors
184
220
  # are retried. Generally, these are throttling errors, data
185
- # checksum errors, networking errors, timeout errors and auth
186
- # errors from expired credentials.
221
+ # checksum errors, networking errors, timeout errors, auth errors,
222
+ # endpoint discovery, and errors from expired credentials.
223
+ # This option is only used in the `legacy` retry mode.
187
224
  #
188
225
  # @option options [Integer] :retry_max_delay (0)
189
- # The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function.
226
+ # The maximum number of seconds to delay between retries (0 for no limit)
227
+ # used by the default backoff function. This option is only used in the
228
+ # `legacy` retry mode.
229
+ #
230
+ # @option options [String] :retry_mode ("legacy")
231
+ # Specifies which retry algorithm to use. Values are:
232
+ #
233
+ # * `legacy` - The pre-existing retry behavior. This is default value if
234
+ # no retry mode is provided.
235
+ #
236
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
237
+ # This includes support for retry quotas, which limit the number of
238
+ # unsuccessful retries a client can make.
239
+ #
240
+ # * `adaptive` - An experimental retry mode that includes all the
241
+ # functionality of `standard` mode along with automatic client side
242
+ # throttling. This is a provisional mode that may change behavior
243
+ # in the future.
244
+ #
190
245
  #
191
246
  # @option options [String] :secret_access_key
192
247
  #
@@ -209,16 +264,15 @@ module Aws::IoTAnalytics
209
264
  # requests through. Formatted like 'http://proxy.com:123'.
210
265
  #
211
266
  # @option options [Float] :http_open_timeout (15) The number of
212
- # seconds to wait when opening a HTTP session before rasing a
267
+ # seconds to wait when opening a HTTP session before raising a
213
268
  # `Timeout::Error`.
214
269
  #
215
270
  # @option options [Integer] :http_read_timeout (60) The default
216
271
  # number of seconds to wait for response data. This value can
217
- # safely be set
218
- # per-request on the session yeidled by {#session_for}.
272
+ # safely be set per-request on the session.
219
273
  #
220
274
  # @option options [Float] :http_idle_timeout (5) The number of
221
- # seconds a connection is allowed to sit idble before it is
275
+ # seconds a connection is allowed to sit idle before it is
222
276
  # considered stale. Stale connections are closed and removed
223
277
  # from the pool before making a request.
224
278
  #
@@ -227,7 +281,7 @@ module Aws::IoTAnalytics
227
281
  # request body. This option has no effect unless the request has
228
282
  # "Expect" header set to "100-continue". Defaults to `nil` which
229
283
  # disables this behaviour. This value can safely be set per
230
- # request on the session yeidled by {#session_for}.
284
+ # request on the session.
231
285
  #
232
286
  # @option options [Boolean] :http_wire_trace (false) When `true`,
233
287
  # HTTP debug output will be sent to the `:logger`.
@@ -348,10 +402,14 @@ module Aws::IoTAnalytics
348
402
  # The name of the channel.
349
403
  #
350
404
  # @option params [Types::ChannelStorage] :channel_storage
351
- # Where channel data is stored.
405
+ # Where channel data is stored. You may choose one of
406
+ # "serviceManagedS3" or "customerManagedS3" storage. If not
407
+ # specified, the default is "serviceManagedS3". This cannot be changed
408
+ # after creation of the channel.
352
409
  #
353
410
  # @option params [Types::RetentionPeriod] :retention_period
354
- # How long, in days, message data is kept for the channel.
411
+ # How long, in days, message data is kept for the channel. When
412
+ # "customerManagedS3" storage is selected, this parameter is ignored.
355
413
  #
356
414
  # @option params [Array<Types::Tag>] :tags
357
415
  # Metadata which can be used to manage the channel.
@@ -584,10 +642,14 @@ module Aws::IoTAnalytics
584
642
  # The name of the data store.
585
643
  #
586
644
  # @option params [Types::DatastoreStorage] :datastore_storage
587
- # Where data store data is stored.
645
+ # Where data store data is stored. You may choose one of
646
+ # "serviceManagedS3" or "customerManagedS3" storage. If not
647
+ # specified, the default is "serviceManagedS3". This cannot be changed
648
+ # after the data store is created.
588
649
  #
589
650
  # @option params [Types::RetentionPeriod] :retention_period
590
- # How long, in days, message data is kept for the data store.
651
+ # How long, in days, message data is kept for the data store. When
652
+ # "customerManagedS3" storage is selected, this parameter is ignored.
591
653
  #
592
654
  # @option params [Array<Types::Tag>] :tags
593
655
  # Metadata which can be used to manage the data store.
@@ -637,10 +699,10 @@ module Aws::IoTAnalytics
637
699
  req.send_request(options)
638
700
  end
639
701
 
640
- # Creates a pipeline. A pipeline consumes messages from one or more
641
- # channels and allows you to process the messages before storing them in
642
- # a data store. You must specify both a `channel` and a `datastore`
643
- # activity and, optionally, as many as 23 additional activities in the
702
+ # Creates a pipeline. A pipeline consumes messages from a channel and
703
+ # allows you to process the messages before storing them in a data
704
+ # store. You must specify both a `channel` and a `datastore` activity
705
+ # and, optionally, as many as 23 additional activities in the
644
706
  # `pipelineActivities` array.
645
707
  #
646
708
  # @option params [required, String] :pipeline_name
@@ -870,7 +932,8 @@ module Aws::IoTAnalytics
870
932
  #
871
933
  # @option params [Boolean] :include_statistics
872
934
  # If true, additional statistical information about the channel is
873
- # included in the response.
935
+ # included in the response. This feature cannot be used with a channel
936
+ # whose S3 storage is customer-managed.
874
937
  #
875
938
  # @return [Types::DescribeChannelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
876
939
  #
@@ -974,8 +1037,9 @@ module Aws::IoTAnalytics
974
1037
  # The name of the data store
975
1038
  #
976
1039
  # @option params [Boolean] :include_statistics
977
- # If true, additional statistical information about the datastore is
978
- # included in the response.
1040
+ # If true, additional statistical information about the data store is
1041
+ # included in the response. This feature cannot be used with a data
1042
+ # store whose S3 storage is customer-managed.
979
1043
  #
980
1044
  # @return [Types::DescribeDatastoreResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
981
1045
  #
@@ -1158,6 +1222,8 @@ module Aws::IoTAnalytics
1158
1222
  # * {Types::ListChannelsResponse#channel_summaries #channel_summaries} => Array&lt;Types::ChannelSummary&gt;
1159
1223
  # * {Types::ListChannelsResponse#next_token #next_token} => String
1160
1224
  #
1225
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1226
+ #
1161
1227
  # @example Request syntax with placeholder values
1162
1228
  #
1163
1229
  # resp = client.list_channels({
@@ -1210,6 +1276,8 @@ module Aws::IoTAnalytics
1210
1276
  # * {Types::ListDatasetContentsResponse#dataset_content_summaries #dataset_content_summaries} => Array&lt;Types::DatasetContentSummary&gt;
1211
1277
  # * {Types::ListDatasetContentsResponse#next_token #next_token} => String
1212
1278
  #
1279
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1280
+ #
1213
1281
  # @example Request syntax with placeholder values
1214
1282
  #
1215
1283
  # resp = client.list_dataset_contents({
@@ -1228,6 +1296,7 @@ module Aws::IoTAnalytics
1228
1296
  # resp.dataset_content_summaries[0].status.reason #=> String
1229
1297
  # resp.dataset_content_summaries[0].creation_time #=> Time
1230
1298
  # resp.dataset_content_summaries[0].schedule_time #=> Time
1299
+ # resp.dataset_content_summaries[0].completion_time #=> Time
1231
1300
  # resp.next_token #=> String
1232
1301
  #
1233
1302
  # @overload list_dataset_contents(params = {})
@@ -1252,6 +1321,8 @@ module Aws::IoTAnalytics
1252
1321
  # * {Types::ListDatasetsResponse#dataset_summaries #dataset_summaries} => Array&lt;Types::DatasetSummary&gt;
1253
1322
  # * {Types::ListDatasetsResponse#next_token #next_token} => String
1254
1323
  #
1324
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1325
+ #
1255
1326
  # @example Request syntax with placeholder values
1256
1327
  #
1257
1328
  # resp = client.list_datasets({
@@ -1296,6 +1367,8 @@ module Aws::IoTAnalytics
1296
1367
  # * {Types::ListDatastoresResponse#datastore_summaries #datastore_summaries} => Array&lt;Types::DatastoreSummary&gt;
1297
1368
  # * {Types::ListDatastoresResponse#next_token #next_token} => String
1298
1369
  #
1370
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1371
+ #
1299
1372
  # @example Request syntax with placeholder values
1300
1373
  #
1301
1374
  # resp = client.list_datastores({
@@ -1337,6 +1410,8 @@ module Aws::IoTAnalytics
1337
1410
  # * {Types::ListPipelinesResponse#pipeline_summaries #pipeline_summaries} => Array&lt;Types::PipelineSummary&gt;
1338
1411
  # * {Types::ListPipelinesResponse#next_token #next_token} => String
1339
1412
  #
1413
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1414
+ #
1340
1415
  # @example Request syntax with placeholder values
1341
1416
  #
1342
1417
  # resp = client.list_pipelines({
@@ -1653,10 +1728,15 @@ module Aws::IoTAnalytics
1653
1728
  # The name of the channel to be updated.
1654
1729
  #
1655
1730
  # @option params [Types::ChannelStorage] :channel_storage
1656
- # Where channel data is stored.
1731
+ # Where channel data is stored. You may choose one of
1732
+ # "serviceManagedS3" or "customerManagedS3" storage. If not
1733
+ # specified, the default is "serviceManagedS3". This cannot be changed
1734
+ # after creation of the channel.
1657
1735
  #
1658
1736
  # @option params [Types::RetentionPeriod] :retention_period
1659
- # How long, in days, message data is kept for the channel.
1737
+ # How long, in days, message data is kept for the channel. The retention
1738
+ # period cannot be updated if the channel's S3 storage is
1739
+ # customer-managed.
1660
1740
  #
1661
1741
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1662
1742
  #
@@ -1809,10 +1889,15 @@ module Aws::IoTAnalytics
1809
1889
  # The name of the data store to be updated.
1810
1890
  #
1811
1891
  # @option params [Types::RetentionPeriod] :retention_period
1812
- # How long, in days, message data is kept for the data store.
1892
+ # How long, in days, message data is kept for the data store. The
1893
+ # retention period cannot be updated if the data store's S3 storage is
1894
+ # customer-managed.
1813
1895
  #
1814
1896
  # @option params [Types::DatastoreStorage] :datastore_storage
1815
- # Where data store data is stored.
1897
+ # Where data store data is stored. You may choose one of
1898
+ # "serviceManagedS3" or "customerManagedS3" storage. If not
1899
+ # specified, the default is "serviceManagedS3". This cannot be changed
1900
+ # after the data store is created.
1816
1901
  #
1817
1902
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1818
1903
  #
@@ -1952,7 +2037,7 @@ module Aws::IoTAnalytics
1952
2037
  params: params,
1953
2038
  config: config)
1954
2039
  context[:gem_name] = 'aws-sdk-iotanalytics'
1955
- context[:gem_version] = '1.24.0'
2040
+ context[:gem_version] = '1.29.0'
1956
2041
  Seahorse::Client::Request.new(handlers, context)
1957
2042
  end
1958
2043
 
@@ -415,6 +415,7 @@ module Aws::IoTAnalytics
415
415
  DatasetContentSummary.add_member(:status, Shapes::ShapeRef.new(shape: DatasetContentStatus, location_name: "status"))
416
416
  DatasetContentSummary.add_member(:creation_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "creationTime"))
417
417
  DatasetContentSummary.add_member(:schedule_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "scheduleTime"))
418
+ DatasetContentSummary.add_member(:completion_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "completionTime"))
418
419
  DatasetContentSummary.struct_class = Types::DatasetContentSummary
419
420
 
420
421
  DatasetContentVersionValue.add_member(:dataset_name, Shapes::ShapeRef.new(shape: DatasetName, required: true, location_name: "datasetName"))
@@ -6,6 +6,35 @@
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
8
  module Aws::IoTAnalytics
9
+
10
+ # When IoTAnalytics returns an error response, the Ruby SDK constructs and raises an error.
11
+ # These errors all extend Aws::IoTAnalytics::Errors::ServiceError < {Aws::Errors::ServiceError}
12
+ #
13
+ # You can rescue all IoTAnalytics errors using ServiceError:
14
+ #
15
+ # begin
16
+ # # do stuff
17
+ # rescue Aws::IoTAnalytics::Errors::ServiceError
18
+ # # rescues all IoTAnalytics API errors
19
+ # end
20
+ #
21
+ #
22
+ # ## Request Context
23
+ # ServiceError objects have a {Aws::Errors::ServiceError#context #context} method that returns
24
+ # information about the request that generated the error.
25
+ # See {Seahorse::Client::RequestContext} for more information.
26
+ #
27
+ # ## Error Classes
28
+ # * {InternalFailureException}
29
+ # * {InvalidRequestException}
30
+ # * {LimitExceededException}
31
+ # * {ResourceAlreadyExistsException}
32
+ # * {ResourceNotFoundException}
33
+ # * {ServiceUnavailableException}
34
+ # * {ThrottlingException}
35
+ #
36
+ # Additionally, error classes are dynamically generated for service errors based on the error code
37
+ # if they are not defined above.
9
38
  module Errors
10
39
 
11
40
  extend Aws::Errors::DynamicErrors
@@ -23,7 +52,6 @@ module Aws::IoTAnalytics
23
52
  def message
24
53
  @message || @data[:message]
25
54
  end
26
-
27
55
  end
28
56
 
29
57
  class InvalidRequestException < ServiceError
@@ -39,7 +67,6 @@ module Aws::IoTAnalytics
39
67
  def message
40
68
  @message || @data[:message]
41
69
  end
42
-
43
70
  end
44
71
 
45
72
  class LimitExceededException < ServiceError
@@ -55,7 +82,6 @@ module Aws::IoTAnalytics
55
82
  def message
56
83
  @message || @data[:message]
57
84
  end
58
-
59
85
  end
60
86
 
61
87
  class ResourceAlreadyExistsException < ServiceError
@@ -81,7 +107,6 @@ module Aws::IoTAnalytics
81
107
  def resource_arn
82
108
  @data[:resource_arn]
83
109
  end
84
-
85
110
  end
86
111
 
87
112
  class ResourceNotFoundException < ServiceError
@@ -97,7 +122,6 @@ module Aws::IoTAnalytics
97
122
  def message
98
123
  @message || @data[:message]
99
124
  end
100
-
101
125
  end
102
126
 
103
127
  class ServiceUnavailableException < ServiceError
@@ -113,7 +137,6 @@ module Aws::IoTAnalytics
113
137
  def message
114
138
  @message || @data[:message]
115
139
  end
116
-
117
140
  end
118
141
 
119
142
  class ThrottlingException < ServiceError
@@ -129,7 +152,6 @@ module Aws::IoTAnalytics
129
152
  def message
130
153
  @message || @data[:message]
131
154
  end
132
-
133
155
  end
134
156
 
135
157
  end
@@ -6,6 +6,7 @@
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
8
  module Aws::IoTAnalytics
9
+
9
10
  class Resource
10
11
 
11
12
  # @param options ({})
@@ -162,7 +162,10 @@ module Aws::IoTAnalytics
162
162
  # @return [String]
163
163
  #
164
164
  # @!attribute [rw] storage
165
- # Where channel data is stored.
165
+ # Where channel data is stored. You may choose one of
166
+ # "serviceManagedS3" or "customerManagedS3" storage. If not
167
+ # specified, the default is "serviceManagedS3". This cannot be
168
+ # changed after creation of the channel.
166
169
  # @return [Types::ChannelStorage]
167
170
  #
168
171
  # @!attribute [rw] arn
@@ -238,7 +241,10 @@ module Aws::IoTAnalytics
238
241
  include Aws::Structure
239
242
  end
240
243
 
241
- # Where channel data is stored.
244
+ # Where channel data is stored. You may choose one of
245
+ # "serviceManagedS3" or "customerManagedS3" storage. If not
246
+ # specified, the default is "serviceManagedS3". This cannot be changed
247
+ # after creation of the channel.
242
248
  #
243
249
  # @note When making an API call, you may pass ChannelStorage
244
250
  # data as a hash:
@@ -255,11 +261,17 @@ module Aws::IoTAnalytics
255
261
  #
256
262
  # @!attribute [rw] service_managed_s3
257
263
  # Use this to store channel data in an S3 bucket managed by the AWS
258
- # IoT Analytics service.
264
+ # IoT Analytics service. The choice of service-managed or
265
+ # customer-managed S3 storage cannot be changed after creation of the
266
+ # channel.
259
267
  # @return [Types::ServiceManagedChannelS3Storage]
260
268
  #
261
269
  # @!attribute [rw] customer_managed_s3
262
- # Use this to store channel data in an S3 bucket that you manage.
270
+ # Use this to store channel data in an S3 bucket that you manage. If
271
+ # customer managed storage is selected, the "retentionPeriod"
272
+ # parameter is ignored. The choice of service-managed or
273
+ # customer-managed S3 storage cannot be changed after creation of the
274
+ # channel.
263
275
  # @return [Types::CustomerManagedChannelS3Storage]
264
276
  #
265
277
  class ChannelStorage < Struct.new(
@@ -409,11 +421,16 @@ module Aws::IoTAnalytics
409
421
  # @return [String]
410
422
  #
411
423
  # @!attribute [rw] channel_storage
412
- # Where channel data is stored.
424
+ # Where channel data is stored. You may choose one of
425
+ # "serviceManagedS3" or "customerManagedS3" storage. If not
426
+ # specified, the default is "serviceManagedS3". This cannot be
427
+ # changed after creation of the channel.
413
428
  # @return [Types::ChannelStorage]
414
429
  #
415
430
  # @!attribute [rw] retention_period
416
- # How long, in days, message data is kept for the channel.
431
+ # How long, in days, message data is kept for the channel. When
432
+ # "customerManagedS3" storage is selected, this parameter is
433
+ # ignored.
417
434
  # @return [Types::RetentionPeriod]
418
435
  #
419
436
  # @!attribute [rw] tags
@@ -663,11 +680,16 @@ module Aws::IoTAnalytics
663
680
  # @return [String]
664
681
  #
665
682
  # @!attribute [rw] datastore_storage
666
- # Where data store data is stored.
683
+ # Where data store data is stored. You may choose one of
684
+ # "serviceManagedS3" or "customerManagedS3" storage. If not
685
+ # specified, the default is "serviceManagedS3". This cannot be
686
+ # changed after the data store is created.
667
687
  # @return [Types::DatastoreStorage]
668
688
  #
669
689
  # @!attribute [rw] retention_period
670
- # How long, in days, message data is kept for the data store.
690
+ # How long, in days, message data is kept for the data store. When
691
+ # "customerManagedS3" storage is selected, this parameter is
692
+ # ignored.
671
693
  # @return [Types::RetentionPeriod]
672
694
  #
673
695
  # @!attribute [rw] tags
@@ -820,7 +842,11 @@ module Aws::IoTAnalytics
820
842
  include Aws::Structure
821
843
  end
822
844
 
823
- # Use this to store channel data in an S3 bucket that you manage.
845
+ # Use this to store channel data in an S3 bucket that you manage. If
846
+ # customer managed storage is selected, the "retentionPeriod"
847
+ # parameter is ignored. The choice of service-managed or
848
+ # customer-managed S3 storage cannot be changed after creation of the
849
+ # channel.
824
850
  #
825
851
  # @note When making an API call, you may pass CustomerManagedChannelS3Storage
826
852
  # data as a hash:
@@ -836,10 +862,10 @@ module Aws::IoTAnalytics
836
862
  # @return [String]
837
863
  #
838
864
  # @!attribute [rw] key_prefix
839
- # The prefix used to create the keys of the channel data objects. Each
840
- # object in an Amazon S3 bucket has a key that is its unique
841
- # identifier within the bucket (each object in a bucket has exactly
842
- # one key).
865
+ # \[Optional\] The prefix used to create the keys of the channel data
866
+ # objects. Each object in an Amazon S3 bucket has a key that is its
867
+ # unique identifier within the bucket (each object in a bucket has
868
+ # exactly one key). The prefix must end with a '/'.
843
869
  # @return [String]
844
870
  #
845
871
  # @!attribute [rw] role_arn
@@ -861,10 +887,10 @@ module Aws::IoTAnalytics
861
887
  # @return [String]
862
888
  #
863
889
  # @!attribute [rw] key_prefix
864
- # The prefix used to create the keys of the channel data objects. Each
865
- # object in an Amazon S3 bucket has a key that is its unique
866
- # identifier within the bucket (each object in a bucket has exactly
867
- # one key).
890
+ # \[Optional\] The prefix used to create the keys of the channel data
891
+ # objects. Each object in an Amazon S3 bucket has a key that is its
892
+ # unique identifier within the bucket (each object in a bucket has
893
+ # exactly one key). The prefix must end with a '/'.
868
894
  # @return [String]
869
895
  #
870
896
  # @!attribute [rw] role_arn
@@ -880,6 +906,10 @@ module Aws::IoTAnalytics
880
906
  end
881
907
 
882
908
  # Use this to store data store data in an S3 bucket that you manage.
909
+ # When customer managed storage is selected, the "retentionPeriod"
910
+ # parameter is ignored. The choice of service-managed or
911
+ # customer-managed S3 storage cannot be changed after creation of the
912
+ # data store.
883
913
  #
884
914
  # @note When making an API call, you may pass CustomerManagedDatastoreS3Storage
885
915
  # data as a hash:
@@ -895,10 +925,10 @@ module Aws::IoTAnalytics
895
925
  # @return [String]
896
926
  #
897
927
  # @!attribute [rw] key_prefix
898
- # The prefix used to create the keys of the data store data objects.
899
- # Each object in an Amazon S3 bucket has a key that is its unique
900
- # identifier within the bucket (each object in a bucket has exactly
901
- # one key).
928
+ # \[Optional\] The prefix used to create the keys of the data store
929
+ # data objects. Each object in an Amazon S3 bucket has a key that is
930
+ # its unique identifier within the bucket (each object in a bucket has
931
+ # exactly one key). The prefix must end with a '/'.
902
932
  # @return [String]
903
933
  #
904
934
  # @!attribute [rw] role_arn
@@ -920,10 +950,10 @@ module Aws::IoTAnalytics
920
950
  # @return [String]
921
951
  #
922
952
  # @!attribute [rw] key_prefix
923
- # The prefix used to create the keys of the data store data objects.
924
- # Each object in an Amazon S3 bucket has a key that is its unique
925
- # identifier within the bucket (each object in a bucket has exactly
926
- # one key).
953
+ # \[Optional\] The prefix used to create the keys of the data store
954
+ # data objects. Each object in an Amazon S3 bucket has a key that is
955
+ # its unique identifier within the bucket (each object in a bucket has
956
+ # exactly one key). The prefix must end with a '/'.
927
957
  # @return [String]
928
958
  #
929
959
  # @!attribute [rw] role_arn
@@ -1201,11 +1231,17 @@ module Aws::IoTAnalytics
1201
1231
  # start.
1202
1232
  # @return [Time]
1203
1233
  #
1234
+ # @!attribute [rw] completion_time
1235
+ # The time the dataset content status was updated to SUCCEEDED or
1236
+ # FAILED.
1237
+ # @return [Time]
1238
+ #
1204
1239
  class DatasetContentSummary < Struct.new(
1205
1240
  :version,
1206
1241
  :status,
1207
1242
  :creation_time,
1208
- :schedule_time)
1243
+ :schedule_time,
1244
+ :completion_time)
1209
1245
  include Aws::Structure
1210
1246
  end
1211
1247
 
@@ -1321,7 +1357,10 @@ module Aws::IoTAnalytics
1321
1357
  # @return [String]
1322
1358
  #
1323
1359
  # @!attribute [rw] storage
1324
- # Where data store data is stored.
1360
+ # Where data store data is stored. You may choose one of
1361
+ # "serviceManagedS3" or "customerManagedS3" storage. If not
1362
+ # specified, the default is "serviceManagedS3". This cannot be
1363
+ # changed after the data store is created.
1325
1364
  # @return [Types::DatastoreStorage]
1326
1365
  #
1327
1366
  # @!attribute [rw] arn
@@ -1345,7 +1384,9 @@ module Aws::IoTAnalytics
1345
1384
  # @return [String]
1346
1385
  #
1347
1386
  # @!attribute [rw] retention_period
1348
- # How long, in days, message data is kept for the data store.
1387
+ # How long, in days, message data is kept for the data store. When
1388
+ # "customerManagedS3" storage is selected, this parameter is
1389
+ # ignored.
1349
1390
  # @return [Types::RetentionPeriod]
1350
1391
  #
1351
1392
  # @!attribute [rw] creation_time
@@ -1403,7 +1444,10 @@ module Aws::IoTAnalytics
1403
1444
  include Aws::Structure
1404
1445
  end
1405
1446
 
1406
- # Where data store data is stored.
1447
+ # Where data store data is stored. You may choose one of
1448
+ # "serviceManagedS3" or "customerManagedS3" storage. If not
1449
+ # specified, the default is "serviceManagedS3". This cannot be changed
1450
+ # after the data store is created.
1407
1451
  #
1408
1452
  # @note When making an API call, you may pass DatastoreStorage
1409
1453
  # data as a hash:
@@ -1420,11 +1464,17 @@ module Aws::IoTAnalytics
1420
1464
  #
1421
1465
  # @!attribute [rw] service_managed_s3
1422
1466
  # Use this to store data store data in an S3 bucket managed by the AWS
1423
- # IoT Analytics service.
1467
+ # IoT Analytics service. The choice of service-managed or
1468
+ # customer-managed S3 storage cannot be changed after creation of the
1469
+ # data store.
1424
1470
  # @return [Types::ServiceManagedDatastoreS3Storage]
1425
1471
  #
1426
1472
  # @!attribute [rw] customer_managed_s3
1427
1473
  # Use this to store data store data in an S3 bucket that you manage.
1474
+ # When customer managed storage is selected, the "retentionPeriod"
1475
+ # parameter is ignored. The choice of service-managed or
1476
+ # customer-managed S3 storage cannot be changed after creation of the
1477
+ # data store.
1428
1478
  # @return [Types::CustomerManagedDatastoreS3Storage]
1429
1479
  #
1430
1480
  class DatastoreStorage < Struct.new(
@@ -1621,7 +1671,8 @@ module Aws::IoTAnalytics
1621
1671
  #
1622
1672
  # @!attribute [rw] include_statistics
1623
1673
  # If true, additional statistical information about the channel is
1624
- # included in the response.
1674
+ # included in the response. This feature cannot be used with a channel
1675
+ # whose S3 storage is customer-managed.
1625
1676
  # @return [Boolean]
1626
1677
  #
1627
1678
  class DescribeChannelRequest < Struct.new(
@@ -1683,8 +1734,9 @@ module Aws::IoTAnalytics
1683
1734
  # @return [String]
1684
1735
  #
1685
1736
  # @!attribute [rw] include_statistics
1686
- # If true, additional statistical information about the datastore is
1687
- # included in the response.
1737
+ # If true, additional statistical information about the data store is
1738
+ # included in the response. This feature cannot be used with a data
1739
+ # store whose S3 storage is customer-managed.
1688
1740
  # @return [Boolean]
1689
1741
  #
1690
1742
  class DescribeDatastoreRequest < Struct.new(
@@ -2898,7 +2950,12 @@ module Aws::IoTAnalytics
2898
2950
  # @!attribute [rw] key
2899
2951
  # The key of the data set contents object. Each object in an Amazon S3
2900
2952
  # bucket has a key that is its unique identifier within the bucket
2901
- # (each object in a bucket has exactly one key).
2953
+ # (each object in a bucket has exactly one key). To produce a unique
2954
+ # key, you can use "!\\\{iotanalytics:scheduledTime\\}" to insert
2955
+ # the time of the scheduled SQL query run, or
2956
+ # "!\\\{iotanalytics:versioned\\} to insert a unique hash identifying
2957
+ # the data set, for example:
2958
+ # "/DataSet/!\\\{iotanalytics:scheduledTime\\}/!\\\{iotanalytics:versioned\\}.csv".
2902
2959
  # @return [String]
2903
2960
  #
2904
2961
  # @!attribute [rw] glue_configuration
@@ -3021,7 +3078,8 @@ module Aws::IoTAnalytics
3021
3078
  end
3022
3079
 
3023
3080
  # Use this to store channel data in an S3 bucket managed by the AWS IoT
3024
- # Analytics service.
3081
+ # Analytics service. The choice of service-managed or customer-managed
3082
+ # S3 storage cannot be changed after creation of the channel.
3025
3083
  #
3026
3084
  # @api private
3027
3085
  #
@@ -3033,7 +3091,9 @@ module Aws::IoTAnalytics
3033
3091
  class ServiceManagedChannelS3StorageSummary < Aws::EmptyStructure; end
3034
3092
 
3035
3093
  # Use this to store data store data in an S3 bucket managed by the AWS
3036
- # IoT Analytics service.
3094
+ # IoT Analytics service. The choice of service-managed or
3095
+ # customer-managed S3 storage cannot be changed after creation of the
3096
+ # data store.
3037
3097
  #
3038
3098
  # @api private
3039
3099
  #
@@ -3254,11 +3314,16 @@ module Aws::IoTAnalytics
3254
3314
  # @return [String]
3255
3315
  #
3256
3316
  # @!attribute [rw] channel_storage
3257
- # Where channel data is stored.
3317
+ # Where channel data is stored. You may choose one of
3318
+ # "serviceManagedS3" or "customerManagedS3" storage. If not
3319
+ # specified, the default is "serviceManagedS3". This cannot be
3320
+ # changed after creation of the channel.
3258
3321
  # @return [Types::ChannelStorage]
3259
3322
  #
3260
3323
  # @!attribute [rw] retention_period
3261
- # How long, in days, message data is kept for the channel.
3324
+ # How long, in days, message data is kept for the channel. The
3325
+ # retention period cannot be updated if the channel's S3 storage is
3326
+ # customer-managed.
3262
3327
  # @return [Types::RetentionPeriod]
3263
3328
  #
3264
3329
  class UpdateChannelRequest < Struct.new(
@@ -3416,11 +3481,16 @@ module Aws::IoTAnalytics
3416
3481
  # @return [String]
3417
3482
  #
3418
3483
  # @!attribute [rw] retention_period
3419
- # How long, in days, message data is kept for the data store.
3484
+ # How long, in days, message data is kept for the data store. The
3485
+ # retention period cannot be updated if the data store's S3 storage
3486
+ # is customer-managed.
3420
3487
  # @return [Types::RetentionPeriod]
3421
3488
  #
3422
3489
  # @!attribute [rw] datastore_storage
3423
- # Where data store data is stored.
3490
+ # Where data store data is stored. You may choose one of
3491
+ # "serviceManagedS3" or "customerManagedS3" storage. If not
3492
+ # specified, the default is "serviceManagedS3". This cannot be
3493
+ # changed after the data store is created.
3424
3494
  # @return [Types::DatastoreStorage]
3425
3495
  #
3426
3496
  class UpdateDatastoreRequest < Struct.new(
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-iotanalytics
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.24.0
4
+ version: 1.29.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2019-07-25 00:00:00.000000000 Z
11
+ date: 2020-05-28 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core
@@ -19,7 +19,7 @@ dependencies:
19
19
  version: '3'
20
20
  - - ">="
21
21
  - !ruby/object:Gem::Version
22
- version: 3.61.1
22
+ version: 3.71.0
23
23
  type: :runtime
24
24
  prerelease: false
25
25
  version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
29
29
  version: '3'
30
30
  - - ">="
31
31
  - !ruby/object:Gem::Version
32
- version: 3.61.1
32
+ version: 3.71.0
33
33
  - !ruby/object:Gem::Dependency
34
34
  name: aws-sigv4
35
35
  requirement: !ruby/object:Gem::Requirement
@@ -81,7 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
81
81
  version: '0'
82
82
  requirements: []
83
83
  rubyforge_project:
84
- rubygems_version: 2.5.2.3
84
+ rubygems_version: 2.7.6.2
85
85
  signing_key:
86
86
  specification_version: 4
87
87
  summary: AWS SDK for Ruby - AWS IoT Analytics