aws-sdk-iotanalytics 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 7151d69c6c29beb260ce97f512c14d2593881682
4
+ data.tar.gz: 19dcff75e170978f177de9283710b353d5a2b837
5
+ SHA512:
6
+ metadata.gz: 2b1d9567a3f6624efc1c4df268c72d19af52697facbe8f1214c1b1a8f5885b4a4df61487263f45596db20fbb4a601bc664d713f452821fcb93385464dacbc382
7
+ data.tar.gz: 55241b1812f7fee658c66f6bc706afc201981de967a2549cc4dad763a9b34a895ab2a405d0c584b383fa1563c6cace8625357bfff6008abdf454a9bec509714e
@@ -0,0 +1,47 @@
1
+ # WARNING ABOUT GENERATED CODE
2
+ #
3
+ # This file is generated. See the contributing guide for more information:
4
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
8
+ require 'aws-sdk-core'
9
+ require 'aws-sigv4'
10
+
11
+ require_relative 'aws-sdk-iotanalytics/types'
12
+ require_relative 'aws-sdk-iotanalytics/client_api'
13
+ require_relative 'aws-sdk-iotanalytics/client'
14
+ require_relative 'aws-sdk-iotanalytics/errors'
15
+ require_relative 'aws-sdk-iotanalytics/resource'
16
+ require_relative 'aws-sdk-iotanalytics/customizations'
17
+
18
+ # This module provides support for AWS IoT Analytics. This module is available in the
19
+ # `aws-sdk-iotanalytics` gem.
20
+ #
21
+ # # Client
22
+ #
23
+ # The {Client} class provides one method for each API operation. Operation
24
+ # methods each accept a hash of request parameters and return a response
25
+ # structure.
26
+ #
27
+ # See {Client} for more information.
28
+ #
29
+ # # Errors
30
+ #
31
+ # Errors returned from AWS IoT Analytics all
32
+ # extend {Errors::ServiceError}.
33
+ #
34
+ # begin
35
+ # # do stuff
36
+ # rescue Aws::IoTAnalytics::Errors::ServiceError
37
+ # # rescues all service API errors
38
+ # end
39
+ #
40
+ # See {Errors} for more information.
41
+ #
42
+ # @service
43
+ module Aws::IoTAnalytics
44
+
45
+ GEM_VERSION = '1.0.0'
46
+
47
+ end
@@ -0,0 +1,1383 @@
1
+ # WARNING ABOUT GENERATED CODE
2
+ #
3
+ # This file is generated. See the contributing guide for more information:
4
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
8
+ require 'seahorse/client/plugins/content_length.rb'
9
+ require 'aws-sdk-core/plugins/credentials_configuration.rb'
10
+ require 'aws-sdk-core/plugins/logging.rb'
11
+ require 'aws-sdk-core/plugins/param_converter.rb'
12
+ require 'aws-sdk-core/plugins/param_validator.rb'
13
+ require 'aws-sdk-core/plugins/user_agent.rb'
14
+ require 'aws-sdk-core/plugins/helpful_socket_errors.rb'
15
+ require 'aws-sdk-core/plugins/retry_errors.rb'
16
+ require 'aws-sdk-core/plugins/global_configuration.rb'
17
+ require 'aws-sdk-core/plugins/regional_endpoint.rb'
18
+ require 'aws-sdk-core/plugins/response_paging.rb'
19
+ require 'aws-sdk-core/plugins/stub_responses.rb'
20
+ require 'aws-sdk-core/plugins/idempotency_token.rb'
21
+ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
22
+ require 'aws-sdk-core/plugins/signature_v4.rb'
23
+ require 'aws-sdk-core/plugins/protocols/rest_json.rb'
24
+
25
+ Aws::Plugins::GlobalConfiguration.add_identifier(:iotanalytics)
26
+
27
+ module Aws::IoTAnalytics
28
+ class Client < Seahorse::Client::Base
29
+
30
+ include Aws::ClientStubs
31
+
32
+ @identifier = :iotanalytics
33
+
34
+ set_api(ClientApi::API)
35
+
36
+ add_plugin(Seahorse::Client::Plugins::ContentLength)
37
+ add_plugin(Aws::Plugins::CredentialsConfiguration)
38
+ add_plugin(Aws::Plugins::Logging)
39
+ add_plugin(Aws::Plugins::ParamConverter)
40
+ add_plugin(Aws::Plugins::ParamValidator)
41
+ add_plugin(Aws::Plugins::UserAgent)
42
+ add_plugin(Aws::Plugins::HelpfulSocketErrors)
43
+ add_plugin(Aws::Plugins::RetryErrors)
44
+ add_plugin(Aws::Plugins::GlobalConfiguration)
45
+ add_plugin(Aws::Plugins::RegionalEndpoint)
46
+ add_plugin(Aws::Plugins::ResponsePaging)
47
+ add_plugin(Aws::Plugins::StubResponses)
48
+ add_plugin(Aws::Plugins::IdempotencyToken)
49
+ add_plugin(Aws::Plugins::JsonvalueConverter)
50
+ add_plugin(Aws::Plugins::SignatureV4)
51
+ add_plugin(Aws::Plugins::Protocols::RestJson)
52
+
53
+ # @option options [required, Aws::CredentialProvider] :credentials
54
+ # Your AWS credentials. This can be an instance of any one of the
55
+ # following classes:
56
+ #
57
+ # * `Aws::Credentials` - Used for configuring static, non-refreshing
58
+ # credentials.
59
+ #
60
+ # * `Aws::InstanceProfileCredentials` - Used for loading credentials
61
+ # from an EC2 IMDS on an EC2 instance.
62
+ #
63
+ # * `Aws::SharedCredentials` - Used for loading credentials from a
64
+ # shared file, such as `~/.aws/config`.
65
+ #
66
+ # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
67
+ #
68
+ # When `:credentials` are not configured directly, the following
69
+ # locations will be searched for credentials:
70
+ #
71
+ # * `Aws.config[:credentials]`
72
+ # * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
73
+ # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
74
+ # * `~/.aws/credentials`
75
+ # * `~/.aws/config`
76
+ # * EC2 IMDS instance profile - When used by default, the timeouts are
77
+ # very aggressive. Construct and pass an instance of
78
+ # `Aws::InstanceProfileCredentails` to enable retries and extended
79
+ # timeouts.
80
+ #
81
+ # @option options [required, String] :region
82
+ # The AWS region to connect to. The configured `:region` is
83
+ # used to determine the service `:endpoint`. When not passed,
84
+ # a default `:region` is search for in the following locations:
85
+ #
86
+ # * `Aws.config[:region]`
87
+ # * `ENV['AWS_REGION']`
88
+ # * `ENV['AMAZON_REGION']`
89
+ # * `ENV['AWS_DEFAULT_REGION']`
90
+ # * `~/.aws/credentials`
91
+ # * `~/.aws/config`
92
+ #
93
+ # @option options [String] :access_key_id
94
+ #
95
+ # @option options [Boolean] :convert_params (true)
96
+ # When `true`, an attempt is made to coerce request parameters into
97
+ # the required types.
98
+ #
99
+ # @option options [String] :endpoint
100
+ # The client endpoint is normally constructed from the `:region`
101
+ # option. You should only configure an `:endpoint` when connecting
102
+ # to test endpoints. This should be avalid HTTP(S) URI.
103
+ #
104
+ # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
105
+ # The log formatter.
106
+ #
107
+ # @option options [Symbol] :log_level (:info)
108
+ # The log level to send messages to the `:logger` at.
109
+ #
110
+ # @option options [Logger] :logger
111
+ # The Logger instance to send log messages to. If this option
112
+ # is not set, logging will be disabled.
113
+ #
114
+ # @option options [String] :profile ("default")
115
+ # Used when loading credentials from the shared credentials file
116
+ # at HOME/.aws/credentials. When not specified, 'default' is used.
117
+ #
118
+ # @option options [Integer] :retry_limit (3)
119
+ # The maximum number of times to retry failed requests. Only
120
+ # ~ 500 level server errors and certain ~ 400 level client errors
121
+ # are retried. Generally, these are throttling errors, data
122
+ # checksum errors, networking errors, timeout errors and auth
123
+ # errors from expired credentials.
124
+ #
125
+ # @option options [String] :secret_access_key
126
+ #
127
+ # @option options [String] :session_token
128
+ #
129
+ # @option options [Boolean] :stub_responses (false)
130
+ # Causes the client to return stubbed responses. By default
131
+ # fake responses are generated and returned. You can specify
132
+ # the response data to return or errors to raise by calling
133
+ # {ClientStubs#stub_responses}. See {ClientStubs} for more information.
134
+ #
135
+ # ** Please note ** When response stubbing is enabled, no HTTP
136
+ # requests are made, and retries are disabled.
137
+ #
138
+ # @option options [Boolean] :validate_params (true)
139
+ # When `true`, request parameters are validated before
140
+ # sending the request.
141
+ #
142
+ def initialize(*args)
143
+ super
144
+ end
145
+
146
+ # @!group API Operations
147
+
148
+ # Sends messages to a channel.
149
+ #
150
+ # @option params [required, String] :channel_name
151
+ # The name of the channel where the messages are sent.
152
+ #
153
+ # @option params [required, Array<Types::Message>] :messages
154
+ # The list of messages to be sent. Each message has format: '\\\{
155
+ # "messageId": "string", "payload": "string"\\}'.
156
+ #
157
+ # @return [Types::BatchPutMessageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
158
+ #
159
+ # * {Types::BatchPutMessageResponse#batch_put_message_error_entries #batch_put_message_error_entries} => Array&lt;Types::BatchPutMessageErrorEntry&gt;
160
+ #
161
+ # @example Request syntax with placeholder values
162
+ #
163
+ # resp = client.batch_put_message({
164
+ # channel_name: "ChannelName", # required
165
+ # messages: [ # required
166
+ # {
167
+ # message_id: "MessageId", # required
168
+ # payload: "data", # required
169
+ # },
170
+ # ],
171
+ # })
172
+ #
173
+ # @example Response structure
174
+ #
175
+ # resp.batch_put_message_error_entries #=> Array
176
+ # resp.batch_put_message_error_entries[0].message_id #=> String
177
+ # resp.batch_put_message_error_entries[0].error_code #=> String
178
+ # resp.batch_put_message_error_entries[0].error_message #=> String
179
+ #
180
+ # @overload batch_put_message(params = {})
181
+ # @param [Hash] params ({})
182
+ def batch_put_message(params = {}, options = {})
183
+ req = build_request(:batch_put_message, params)
184
+ req.send_request(options)
185
+ end
186
+
187
+ # Cancels the reprocessing of data through the pipeline.
188
+ #
189
+ # @option params [required, String] :pipeline_name
190
+ # The name of pipeline for which data reprocessing is canceled.
191
+ #
192
+ # @option params [required, String] :reprocessing_id
193
+ # The ID of the reprocessing task (returned by
194
+ # "StartPipelineReprocessing").
195
+ #
196
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
197
+ #
198
+ # @example Request syntax with placeholder values
199
+ #
200
+ # resp = client.cancel_pipeline_reprocessing({
201
+ # pipeline_name: "PipelineName", # required
202
+ # reprocessing_id: "ReprocessingId", # required
203
+ # })
204
+ #
205
+ # @overload cancel_pipeline_reprocessing(params = {})
206
+ # @param [Hash] params ({})
207
+ def cancel_pipeline_reprocessing(params = {}, options = {})
208
+ req = build_request(:cancel_pipeline_reprocessing, params)
209
+ req.send_request(options)
210
+ end
211
+
212
+ # Creates a channel. A channel collects data from an MQTT topic and
213
+ # archives the raw, unprocessed messages before publishing the data to a
214
+ # pipeline.
215
+ #
216
+ # @option params [required, String] :channel_name
217
+ # The name of the channel.
218
+ #
219
+ # @option params [Types::RetentionPeriod] :retention_period
220
+ # How long, in days, message data is kept for the channel.
221
+ #
222
+ # @return [Types::CreateChannelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
223
+ #
224
+ # * {Types::CreateChannelResponse#channel_name #channel_name} => String
225
+ # * {Types::CreateChannelResponse#channel_arn #channel_arn} => String
226
+ # * {Types::CreateChannelResponse#retention_period #retention_period} => Types::RetentionPeriod
227
+ #
228
+ # @example Request syntax with placeholder values
229
+ #
230
+ # resp = client.create_channel({
231
+ # channel_name: "ChannelName", # required
232
+ # retention_period: {
233
+ # unlimited: false,
234
+ # number_of_days: 1,
235
+ # },
236
+ # })
237
+ #
238
+ # @example Response structure
239
+ #
240
+ # resp.channel_name #=> String
241
+ # resp.channel_arn #=> String
242
+ # resp.retention_period.unlimited #=> Boolean
243
+ # resp.retention_period.number_of_days #=> Integer
244
+ #
245
+ # @overload create_channel(params = {})
246
+ # @param [Hash] params ({})
247
+ def create_channel(params = {}, options = {})
248
+ req = build_request(:create_channel, params)
249
+ req.send_request(options)
250
+ end
251
+
252
+ # Creates a data set. A data set stores data retrieved from a data store
253
+ # by applying an SQL action.
254
+ #
255
+ # <note markdown="1"> This operation creates the skeleton of a data set. To populate the
256
+ # data set, call "CreateDatasetContent".
257
+ #
258
+ # </note>
259
+ #
260
+ # @option params [required, String] :dataset_name
261
+ # The name of the data set.
262
+ #
263
+ # @option params [required, Array<Types::DatasetAction>] :actions
264
+ # A list of actions that create the data set. Only one action is
265
+ # supported at this time.
266
+ #
267
+ # @option params [Array<Types::DatasetTrigger>] :triggers
268
+ # A list of triggers. A trigger causes data set content to be populated
269
+ # at a specified time or time interval. The list of triggers can be
270
+ # empty or contain up to five **DataSetTrigger** objects.
271
+ #
272
+ # @return [Types::CreateDatasetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
273
+ #
274
+ # * {Types::CreateDatasetResponse#dataset_name #dataset_name} => String
275
+ # * {Types::CreateDatasetResponse#dataset_arn #dataset_arn} => String
276
+ #
277
+ # @example Request syntax with placeholder values
278
+ #
279
+ # resp = client.create_dataset({
280
+ # dataset_name: "DatasetName", # required
281
+ # actions: [ # required
282
+ # {
283
+ # action_name: "DatasetActionName",
284
+ # query_action: {
285
+ # sql_query: "SqlQuery", # required
286
+ # },
287
+ # },
288
+ # ],
289
+ # triggers: [
290
+ # {
291
+ # schedule: {
292
+ # expression: "ScheduleExpression",
293
+ # },
294
+ # },
295
+ # ],
296
+ # })
297
+ #
298
+ # @example Response structure
299
+ #
300
+ # resp.dataset_name #=> String
301
+ # resp.dataset_arn #=> String
302
+ #
303
+ # @overload create_dataset(params = {})
304
+ # @param [Hash] params ({})
305
+ def create_dataset(params = {}, options = {})
306
+ req = build_request(:create_dataset, params)
307
+ req.send_request(options)
308
+ end
309
+
310
+ # Creates the content of a data set by applying an SQL action.
311
+ #
312
+ # @option params [required, String] :dataset_name
313
+ # The name of the data set.
314
+ #
315
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
316
+ #
317
+ # @example Request syntax with placeholder values
318
+ #
319
+ # resp = client.create_dataset_content({
320
+ # dataset_name: "DatasetName", # required
321
+ # })
322
+ #
323
+ # @overload create_dataset_content(params = {})
324
+ # @param [Hash] params ({})
325
+ def create_dataset_content(params = {}, options = {})
326
+ req = build_request(:create_dataset_content, params)
327
+ req.send_request(options)
328
+ end
329
+
330
+ # Creates a data store, which is a repository for messages.
331
+ #
332
+ # @option params [required, String] :datastore_name
333
+ # The name of the data store.
334
+ #
335
+ # @option params [Types::RetentionPeriod] :retention_period
336
+ # How long, in days, message data is kept for the data store.
337
+ #
338
+ # @return [Types::CreateDatastoreResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
339
+ #
340
+ # * {Types::CreateDatastoreResponse#datastore_name #datastore_name} => String
341
+ # * {Types::CreateDatastoreResponse#datastore_arn #datastore_arn} => String
342
+ # * {Types::CreateDatastoreResponse#retention_period #retention_period} => Types::RetentionPeriod
343
+ #
344
+ # @example Request syntax with placeholder values
345
+ #
346
+ # resp = client.create_datastore({
347
+ # datastore_name: "DatastoreName", # required
348
+ # retention_period: {
349
+ # unlimited: false,
350
+ # number_of_days: 1,
351
+ # },
352
+ # })
353
+ #
354
+ # @example Response structure
355
+ #
356
+ # resp.datastore_name #=> String
357
+ # resp.datastore_arn #=> String
358
+ # resp.retention_period.unlimited #=> Boolean
359
+ # resp.retention_period.number_of_days #=> Integer
360
+ #
361
+ # @overload create_datastore(params = {})
362
+ # @param [Hash] params ({})
363
+ def create_datastore(params = {}, options = {})
364
+ req = build_request(:create_datastore, params)
365
+ req.send_request(options)
366
+ end
367
+
368
+ # Creates a pipeline. A pipeline consumes messages from one or more
369
+ # channels and allows you to process the messages before storing them in
370
+ # a data store.
371
+ #
372
+ # @option params [required, String] :pipeline_name
373
+ # The name of the pipeline.
374
+ #
375
+ # @option params [required, Array<Types::PipelineActivity>] :pipeline_activities
376
+ # A list of pipeline activities.
377
+ #
378
+ # The list can be 1-25 **PipelineActivity** objects. Activities perform
379
+ # transformations on your messages, such as removing, renaming, or
380
+ # adding message attributes; filtering messages based on attribute
381
+ # values; invoking your Lambda functions on messages for advanced
382
+ # processing; or performing mathematical transformations to normalize
383
+ # device data.
384
+ #
385
+ # @return [Types::CreatePipelineResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
386
+ #
387
+ # * {Types::CreatePipelineResponse#pipeline_name #pipeline_name} => String
388
+ # * {Types::CreatePipelineResponse#pipeline_arn #pipeline_arn} => String
389
+ #
390
+ # @example Request syntax with placeholder values
391
+ #
392
+ # resp = client.create_pipeline({
393
+ # pipeline_name: "PipelineName", # required
394
+ # pipeline_activities: [ # required
395
+ # {
396
+ # channel: {
397
+ # name: "ActivityName", # required
398
+ # channel_name: "ChannelName", # required
399
+ # next: "ActivityName",
400
+ # },
401
+ # lambda: {
402
+ # name: "ActivityName", # required
403
+ # lambda_name: "LambdaName", # required
404
+ # batch_size: 1, # required
405
+ # next: "ActivityName",
406
+ # },
407
+ # datastore: {
408
+ # name: "ActivityName", # required
409
+ # datastore_name: "DatastoreName", # required
410
+ # },
411
+ # add_attributes: {
412
+ # name: "ActivityName", # required
413
+ # attributes: { # required
414
+ # "AttributeName" => "AttributeName",
415
+ # },
416
+ # next: "ActivityName",
417
+ # },
418
+ # remove_attributes: {
419
+ # name: "ActivityName", # required
420
+ # attributes: ["AttributeName"], # required
421
+ # next: "ActivityName",
422
+ # },
423
+ # select_attributes: {
424
+ # name: "ActivityName", # required
425
+ # attributes: ["AttributeName"], # required
426
+ # next: "ActivityName",
427
+ # },
428
+ # filter: {
429
+ # name: "ActivityName", # required
430
+ # filter: "FilterExpression", # required
431
+ # next: "ActivityName",
432
+ # },
433
+ # math: {
434
+ # name: "ActivityName", # required
435
+ # attribute: "AttributeName", # required
436
+ # math: "MathExpression", # required
437
+ # next: "ActivityName",
438
+ # },
439
+ # device_registry_enrich: {
440
+ # name: "ActivityName", # required
441
+ # attribute: "AttributeName", # required
442
+ # thing_name: "AttributeName", # required
443
+ # role_arn: "RoleArn", # required
444
+ # next: "ActivityName",
445
+ # },
446
+ # device_shadow_enrich: {
447
+ # name: "ActivityName", # required
448
+ # attribute: "AttributeName", # required
449
+ # thing_name: "AttributeName", # required
450
+ # role_arn: "RoleArn", # required
451
+ # next: "ActivityName",
452
+ # },
453
+ # },
454
+ # ],
455
+ # })
456
+ #
457
+ # @example Response structure
458
+ #
459
+ # resp.pipeline_name #=> String
460
+ # resp.pipeline_arn #=> String
461
+ #
462
+ # @overload create_pipeline(params = {})
463
+ # @param [Hash] params ({})
464
+ def create_pipeline(params = {}, options = {})
465
+ req = build_request(:create_pipeline, params)
466
+ req.send_request(options)
467
+ end
468
+
469
+ # Deletes the specified channel.
470
+ #
471
+ # @option params [required, String] :channel_name
472
+ # The name of the channel to delete.
473
+ #
474
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
475
+ #
476
+ # @example Request syntax with placeholder values
477
+ #
478
+ # resp = client.delete_channel({
479
+ # channel_name: "ChannelName", # required
480
+ # })
481
+ #
482
+ # @overload delete_channel(params = {})
483
+ # @param [Hash] params ({})
484
+ def delete_channel(params = {}, options = {})
485
+ req = build_request(:delete_channel, params)
486
+ req.send_request(options)
487
+ end
488
+
489
+ # Deletes the specified data set.
490
+ #
491
+ # You do not have to delete the content of the data set before you
492
+ # perform this operation.
493
+ #
494
+ # @option params [required, String] :dataset_name
495
+ # The name of the data set to delete.
496
+ #
497
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
498
+ #
499
+ # @example Request syntax with placeholder values
500
+ #
501
+ # resp = client.delete_dataset({
502
+ # dataset_name: "DatasetName", # required
503
+ # })
504
+ #
505
+ # @overload delete_dataset(params = {})
506
+ # @param [Hash] params ({})
507
+ def delete_dataset(params = {}, options = {})
508
+ req = build_request(:delete_dataset, params)
509
+ req.send_request(options)
510
+ end
511
+
512
+ # Deletes the content of the specified data set.
513
+ #
514
+ # @option params [required, String] :dataset_name
515
+ # The name of the data set whose content is deleted.
516
+ #
517
+ # @option params [String] :version_id
518
+ # The version of the data set whose content is deleted. You can also use
519
+ # the strings "$LATEST" or "$LATEST\_SUCCEEDED" to delete the latest
520
+ # or latest successfully completed data set. If not specified,
521
+ # "$LATEST\_SUCCEEDED" is the default.
522
+ #
523
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
524
+ #
525
+ # @example Request syntax with placeholder values
526
+ #
527
+ # resp = client.delete_dataset_content({
528
+ # dataset_name: "DatasetName", # required
529
+ # version_id: "DatasetContentVersion",
530
+ # })
531
+ #
532
+ # @overload delete_dataset_content(params = {})
533
+ # @param [Hash] params ({})
534
+ def delete_dataset_content(params = {}, options = {})
535
+ req = build_request(:delete_dataset_content, params)
536
+ req.send_request(options)
537
+ end
538
+
539
+ # Deletes the specified data store.
540
+ #
541
+ # @option params [required, String] :datastore_name
542
+ # The name of the data store to delete.
543
+ #
544
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
545
+ #
546
+ # @example Request syntax with placeholder values
547
+ #
548
+ # resp = client.delete_datastore({
549
+ # datastore_name: "DatastoreName", # required
550
+ # })
551
+ #
552
+ # @overload delete_datastore(params = {})
553
+ # @param [Hash] params ({})
554
+ def delete_datastore(params = {}, options = {})
555
+ req = build_request(:delete_datastore, params)
556
+ req.send_request(options)
557
+ end
558
+
559
+ # Deletes the specified pipeline.
560
+ #
561
+ # @option params [required, String] :pipeline_name
562
+ # The name of the pipeline to delete.
563
+ #
564
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
565
+ #
566
+ # @example Request syntax with placeholder values
567
+ #
568
+ # resp = client.delete_pipeline({
569
+ # pipeline_name: "PipelineName", # required
570
+ # })
571
+ #
572
+ # @overload delete_pipeline(params = {})
573
+ # @param [Hash] params ({})
574
+ def delete_pipeline(params = {}, options = {})
575
+ req = build_request(:delete_pipeline, params)
576
+ req.send_request(options)
577
+ end
578
+
579
+ # Retrieves information about a channel.
580
+ #
581
+ # @option params [required, String] :channel_name
582
+ # The name of the channel whose information is retrieved.
583
+ #
584
+ # @return [Types::DescribeChannelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
585
+ #
586
+ # * {Types::DescribeChannelResponse#channel #channel} => Types::Channel
587
+ #
588
+ # @example Request syntax with placeholder values
589
+ #
590
+ # resp = client.describe_channel({
591
+ # channel_name: "ChannelName", # required
592
+ # })
593
+ #
594
+ # @example Response structure
595
+ #
596
+ # resp.channel.name #=> String
597
+ # resp.channel.arn #=> String
598
+ # resp.channel.status #=> String, one of "CREATING", "ACTIVE", "DELETING"
599
+ # resp.channel.retention_period.unlimited #=> Boolean
600
+ # resp.channel.retention_period.number_of_days #=> Integer
601
+ # resp.channel.creation_time #=> Time
602
+ # resp.channel.last_update_time #=> Time
603
+ #
604
+ # @overload describe_channel(params = {})
605
+ # @param [Hash] params ({})
606
+ def describe_channel(params = {}, options = {})
607
+ req = build_request(:describe_channel, params)
608
+ req.send_request(options)
609
+ end
610
+
611
+ # Retrieves information about a data set.
612
+ #
613
+ # @option params [required, String] :dataset_name
614
+ # The name of the data set whose information is retrieved.
615
+ #
616
+ # @return [Types::DescribeDatasetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
617
+ #
618
+ # * {Types::DescribeDatasetResponse#dataset #dataset} => Types::Dataset
619
+ #
620
+ # @example Request syntax with placeholder values
621
+ #
622
+ # resp = client.describe_dataset({
623
+ # dataset_name: "DatasetName", # required
624
+ # })
625
+ #
626
+ # @example Response structure
627
+ #
628
+ # resp.dataset.name #=> String
629
+ # resp.dataset.arn #=> String
630
+ # resp.dataset.actions #=> Array
631
+ # resp.dataset.actions[0].action_name #=> String
632
+ # resp.dataset.actions[0].query_action.sql_query #=> String
633
+ # resp.dataset.triggers #=> Array
634
+ # resp.dataset.triggers[0].schedule.expression #=> String
635
+ # resp.dataset.status #=> String, one of "CREATING", "ACTIVE", "DELETING"
636
+ # resp.dataset.creation_time #=> Time
637
+ # resp.dataset.last_update_time #=> Time
638
+ #
639
+ # @overload describe_dataset(params = {})
640
+ # @param [Hash] params ({})
641
+ def describe_dataset(params = {}, options = {})
642
+ req = build_request(:describe_dataset, params)
643
+ req.send_request(options)
644
+ end
645
+
646
+ # Retrieves information about a data store.
647
+ #
648
+ # @option params [required, String] :datastore_name
649
+ # The name of the data store
650
+ #
651
+ # @return [Types::DescribeDatastoreResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
652
+ #
653
+ # * {Types::DescribeDatastoreResponse#datastore #datastore} => Types::Datastore
654
+ #
655
+ # @example Request syntax with placeholder values
656
+ #
657
+ # resp = client.describe_datastore({
658
+ # datastore_name: "DatastoreName", # required
659
+ # })
660
+ #
661
+ # @example Response structure
662
+ #
663
+ # resp.datastore.name #=> String
664
+ # resp.datastore.arn #=> String
665
+ # resp.datastore.status #=> String, one of "CREATING", "ACTIVE", "DELETING"
666
+ # resp.datastore.retention_period.unlimited #=> Boolean
667
+ # resp.datastore.retention_period.number_of_days #=> Integer
668
+ # resp.datastore.creation_time #=> Time
669
+ # resp.datastore.last_update_time #=> Time
670
+ #
671
+ # @overload describe_datastore(params = {})
672
+ # @param [Hash] params ({})
673
+ def describe_datastore(params = {}, options = {})
674
+ req = build_request(:describe_datastore, params)
675
+ req.send_request(options)
676
+ end
677
+
678
+ # Retrieves the current settings of the AWS IoT Analytics logging
679
+ # options.
680
+ #
681
+ # @return [Types::DescribeLoggingOptionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
682
+ #
683
+ # * {Types::DescribeLoggingOptionsResponse#logging_options #logging_options} => Types::LoggingOptions
684
+ #
685
+ # @example Response structure
686
+ #
687
+ # resp.logging_options.role_arn #=> String
688
+ # resp.logging_options.level #=> String, one of "ERROR"
689
+ # resp.logging_options.enabled #=> Boolean
690
+ #
691
+ # @overload describe_logging_options(params = {})
692
+ # @param [Hash] params ({})
693
+ def describe_logging_options(params = {}, options = {})
694
+ req = build_request(:describe_logging_options, params)
695
+ req.send_request(options)
696
+ end
697
+
698
+ # Retrieves information about a pipeline.
699
+ #
700
+ # @option params [required, String] :pipeline_name
701
+ # The name of the pipeline whose information is retrieved.
702
+ #
703
+ # @return [Types::DescribePipelineResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
704
+ #
705
+ # * {Types::DescribePipelineResponse#pipeline #pipeline} => Types::Pipeline
706
+ #
707
+ # @example Request syntax with placeholder values
708
+ #
709
+ # resp = client.describe_pipeline({
710
+ # pipeline_name: "PipelineName", # required
711
+ # })
712
+ #
713
+ # @example Response structure
714
+ #
715
+ # resp.pipeline.name #=> String
716
+ # resp.pipeline.arn #=> String
717
+ # resp.pipeline.activities #=> Array
718
+ # resp.pipeline.activities[0].channel.name #=> String
719
+ # resp.pipeline.activities[0].channel.channel_name #=> String
720
+ # resp.pipeline.activities[0].channel.next #=> String
721
+ # resp.pipeline.activities[0].lambda.name #=> String
722
+ # resp.pipeline.activities[0].lambda.lambda_name #=> String
723
+ # resp.pipeline.activities[0].lambda.batch_size #=> Integer
724
+ # resp.pipeline.activities[0].lambda.next #=> String
725
+ # resp.pipeline.activities[0].datastore.name #=> String
726
+ # resp.pipeline.activities[0].datastore.datastore_name #=> String
727
+ # resp.pipeline.activities[0].add_attributes.name #=> String
728
+ # resp.pipeline.activities[0].add_attributes.attributes #=> Hash
729
+ # resp.pipeline.activities[0].add_attributes.attributes["AttributeName"] #=> String
730
+ # resp.pipeline.activities[0].add_attributes.next #=> String
731
+ # resp.pipeline.activities[0].remove_attributes.name #=> String
732
+ # resp.pipeline.activities[0].remove_attributes.attributes #=> Array
733
+ # resp.pipeline.activities[0].remove_attributes.attributes[0] #=> String
734
+ # resp.pipeline.activities[0].remove_attributes.next #=> String
735
+ # resp.pipeline.activities[0].select_attributes.name #=> String
736
+ # resp.pipeline.activities[0].select_attributes.attributes #=> Array
737
+ # resp.pipeline.activities[0].select_attributes.attributes[0] #=> String
738
+ # resp.pipeline.activities[0].select_attributes.next #=> String
739
+ # resp.pipeline.activities[0].filter.name #=> String
740
+ # resp.pipeline.activities[0].filter.filter #=> String
741
+ # resp.pipeline.activities[0].filter.next #=> String
742
+ # resp.pipeline.activities[0].math.name #=> String
743
+ # resp.pipeline.activities[0].math.attribute #=> String
744
+ # resp.pipeline.activities[0].math.math #=> String
745
+ # resp.pipeline.activities[0].math.next #=> String
746
+ # resp.pipeline.activities[0].device_registry_enrich.name #=> String
747
+ # resp.pipeline.activities[0].device_registry_enrich.attribute #=> String
748
+ # resp.pipeline.activities[0].device_registry_enrich.thing_name #=> String
749
+ # resp.pipeline.activities[0].device_registry_enrich.role_arn #=> String
750
+ # resp.pipeline.activities[0].device_registry_enrich.next #=> String
751
+ # resp.pipeline.activities[0].device_shadow_enrich.name #=> String
752
+ # resp.pipeline.activities[0].device_shadow_enrich.attribute #=> String
753
+ # resp.pipeline.activities[0].device_shadow_enrich.thing_name #=> String
754
+ # resp.pipeline.activities[0].device_shadow_enrich.role_arn #=> String
755
+ # resp.pipeline.activities[0].device_shadow_enrich.next #=> String
756
+ # resp.pipeline.reprocessing_summaries #=> Array
757
+ # resp.pipeline.reprocessing_summaries[0].id #=> String
758
+ # resp.pipeline.reprocessing_summaries[0].status #=> String, one of "RUNNING", "SUCCEEDED", "CANCELLED", "FAILED"
759
+ # resp.pipeline.reprocessing_summaries[0].creation_time #=> Time
760
+ # resp.pipeline.creation_time #=> Time
761
+ # resp.pipeline.last_update_time #=> Time
762
+ #
763
+ # @overload describe_pipeline(params = {})
764
+ # @param [Hash] params ({})
765
+ def describe_pipeline(params = {}, options = {})
766
+ req = build_request(:describe_pipeline, params)
767
+ req.send_request(options)
768
+ end
769
+
770
+ # Retrieves the contents of a data set as pre-signed URIs.
771
+ #
772
+ # @option params [required, String] :dataset_name
773
+ # The name of the data set whose contents are retrieved.
774
+ #
775
+ # @option params [String] :version_id
776
+ # The version of the data set whose contents are retrieved. You can also
777
+ # use the strings "$LATEST" or "$LATEST\_SUCCEEDED" to retrieve the
778
+ # contents of the latest or latest successfully completed data set. If
779
+ # not specified, "$LATEST\_SUCCEEDED" is the default.
780
+ #
781
+ # @return [Types::GetDatasetContentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
782
+ #
783
+ # * {Types::GetDatasetContentResponse#entries #entries} => Array&lt;Types::DatasetEntry&gt;
784
+ # * {Types::GetDatasetContentResponse#timestamp #timestamp} => Time
785
+ # * {Types::GetDatasetContentResponse#status #status} => Types::DatasetContentStatus
786
+ #
787
+ # @example Request syntax with placeholder values
788
+ #
789
+ # resp = client.get_dataset_content({
790
+ # dataset_name: "DatasetName", # required
791
+ # version_id: "DatasetContentVersion",
792
+ # })
793
+ #
794
+ # @example Response structure
795
+ #
796
+ # resp.entries #=> Array
797
+ # resp.entries[0].entry_name #=> String
798
+ # resp.entries[0].data_uri #=> String
799
+ # resp.timestamp #=> Time
800
+ # resp.status.state #=> String, one of "CREATING", "SUCCEEDED", "FAILED"
801
+ # resp.status.reason #=> String
802
+ #
803
+ # @overload get_dataset_content(params = {})
804
+ # @param [Hash] params ({})
805
+ def get_dataset_content(params = {}, options = {})
806
+ req = build_request(:get_dataset_content, params)
807
+ req.send_request(options)
808
+ end
809
+
810
+ # Retrieves a list of channels.
811
+ #
812
+ # @option params [String] :next_token
813
+ # The token for the next set of results.
814
+ #
815
+ # @option params [Integer] :max_results
816
+ # The maximum number of results to return in this request.
817
+ #
818
+ # The default value is 100.
819
+ #
820
+ # @return [Types::ListChannelsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
821
+ #
822
+ # * {Types::ListChannelsResponse#channel_summaries #channel_summaries} => Array&lt;Types::ChannelSummary&gt;
823
+ # * {Types::ListChannelsResponse#next_token #next_token} => String
824
+ #
825
+ # @example Request syntax with placeholder values
826
+ #
827
+ # resp = client.list_channels({
828
+ # next_token: "NextToken",
829
+ # max_results: 1,
830
+ # })
831
+ #
832
+ # @example Response structure
833
+ #
834
+ # resp.channel_summaries #=> Array
835
+ # resp.channel_summaries[0].channel_name #=> String
836
+ # resp.channel_summaries[0].status #=> String, one of "CREATING", "ACTIVE", "DELETING"
837
+ # resp.channel_summaries[0].creation_time #=> Time
838
+ # resp.channel_summaries[0].last_update_time #=> Time
839
+ # resp.next_token #=> String
840
+ #
841
+ # @overload list_channels(params = {})
842
+ # @param [Hash] params ({})
843
+ def list_channels(params = {}, options = {})
844
+ req = build_request(:list_channels, params)
845
+ req.send_request(options)
846
+ end
847
+
848
+ # Retrieves information about data sets.
849
+ #
850
+ # @option params [String] :next_token
851
+ # The token for the next set of results.
852
+ #
853
+ # @option params [Integer] :max_results
854
+ # The maximum number of results to return in this request.
855
+ #
856
+ # The default value is 100.
857
+ #
858
+ # @return [Types::ListDatasetsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
859
+ #
860
+ # * {Types::ListDatasetsResponse#dataset_summaries #dataset_summaries} => Array&lt;Types::DatasetSummary&gt;
861
+ # * {Types::ListDatasetsResponse#next_token #next_token} => String
862
+ #
863
+ # @example Request syntax with placeholder values
864
+ #
865
+ # resp = client.list_datasets({
866
+ # next_token: "NextToken",
867
+ # max_results: 1,
868
+ # })
869
+ #
870
+ # @example Response structure
871
+ #
872
+ # resp.dataset_summaries #=> Array
873
+ # resp.dataset_summaries[0].dataset_name #=> String
874
+ # resp.dataset_summaries[0].status #=> String, one of "CREATING", "ACTIVE", "DELETING"
875
+ # resp.dataset_summaries[0].creation_time #=> Time
876
+ # resp.dataset_summaries[0].last_update_time #=> Time
877
+ # resp.next_token #=> String
878
+ #
879
+ # @overload list_datasets(params = {})
880
+ # @param [Hash] params ({})
881
+ def list_datasets(params = {}, options = {})
882
+ req = build_request(:list_datasets, params)
883
+ req.send_request(options)
884
+ end
885
+
886
+ # Retrieves a list of data stores.
887
+ #
888
+ # @option params [String] :next_token
889
+ # The token for the next set of results.
890
+ #
891
+ # @option params [Integer] :max_results
892
+ # The maximum number of results to return in this request.
893
+ #
894
+ # The default value is 100.
895
+ #
896
+ # @return [Types::ListDatastoresResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
897
+ #
898
+ # * {Types::ListDatastoresResponse#datastore_summaries #datastore_summaries} => Array&lt;Types::DatastoreSummary&gt;
899
+ # * {Types::ListDatastoresResponse#next_token #next_token} => String
900
+ #
901
+ # @example Request syntax with placeholder values
902
+ #
903
+ # resp = client.list_datastores({
904
+ # next_token: "NextToken",
905
+ # max_results: 1,
906
+ # })
907
+ #
908
+ # @example Response structure
909
+ #
910
+ # resp.datastore_summaries #=> Array
911
+ # resp.datastore_summaries[0].datastore_name #=> String
912
+ # resp.datastore_summaries[0].status #=> String, one of "CREATING", "ACTIVE", "DELETING"
913
+ # resp.datastore_summaries[0].creation_time #=> Time
914
+ # resp.datastore_summaries[0].last_update_time #=> Time
915
+ # resp.next_token #=> String
916
+ #
917
+ # @overload list_datastores(params = {})
918
+ # @param [Hash] params ({})
919
+ def list_datastores(params = {}, options = {})
920
+ req = build_request(:list_datastores, params)
921
+ req.send_request(options)
922
+ end
923
+
924
+ # Retrieves a list of pipelines.
925
+ #
926
+ # @option params [String] :next_token
927
+ # The token for the next set of results.
928
+ #
929
+ # @option params [Integer] :max_results
930
+ # The maximum number of results to return in this request.
931
+ #
932
+ # The default value is 100.
933
+ #
934
+ # @return [Types::ListPipelinesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
935
+ #
936
+ # * {Types::ListPipelinesResponse#pipeline_summaries #pipeline_summaries} => Array&lt;Types::PipelineSummary&gt;
937
+ # * {Types::ListPipelinesResponse#next_token #next_token} => String
938
+ #
939
+ # @example Request syntax with placeholder values
940
+ #
941
+ # resp = client.list_pipelines({
942
+ # next_token: "NextToken",
943
+ # max_results: 1,
944
+ # })
945
+ #
946
+ # @example Response structure
947
+ #
948
+ # resp.pipeline_summaries #=> Array
949
+ # resp.pipeline_summaries[0].pipeline_name #=> String
950
+ # resp.pipeline_summaries[0].reprocessing_summaries #=> Array
951
+ # resp.pipeline_summaries[0].reprocessing_summaries[0].id #=> String
952
+ # resp.pipeline_summaries[0].reprocessing_summaries[0].status #=> String, one of "RUNNING", "SUCCEEDED", "CANCELLED", "FAILED"
953
+ # resp.pipeline_summaries[0].reprocessing_summaries[0].creation_time #=> Time
954
+ # resp.pipeline_summaries[0].creation_time #=> Time
955
+ # resp.pipeline_summaries[0].last_update_time #=> Time
956
+ # resp.next_token #=> String
957
+ #
958
+ # @overload list_pipelines(params = {})
959
+ # @param [Hash] params ({})
960
+ def list_pipelines(params = {}, options = {})
961
+ req = build_request(:list_pipelines, params)
962
+ req.send_request(options)
963
+ end
964
+
965
+ # Sets or updates the AWS IoT Analytics logging options.
966
+ #
967
+ # @option params [required, Types::LoggingOptions] :logging_options
968
+ # The new values of the AWS IoT Analytics logging options.
969
+ #
970
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
971
+ #
972
+ # @example Request syntax with placeholder values
973
+ #
974
+ # resp = client.put_logging_options({
975
+ # logging_options: { # required
976
+ # role_arn: "RoleArn", # required
977
+ # level: "ERROR", # required, accepts ERROR
978
+ # enabled: false, # required
979
+ # },
980
+ # })
981
+ #
982
+ # @overload put_logging_options(params = {})
983
+ # @param [Hash] params ({})
984
+ def put_logging_options(params = {}, options = {})
985
+ req = build_request(:put_logging_options, params)
986
+ req.send_request(options)
987
+ end
988
+
989
+ # Simulates the results of running a pipeline activity on a message
990
+ # payload.
991
+ #
992
+ # @option params [required, Types::PipelineActivity] :pipeline_activity
993
+ # The pipeline activity that is run. This must not be a 'channel'
994
+ # activity or a 'datastore' activity because these activities are used
995
+ # in a pipeline only to load the original message and to store the
996
+ # (possibly) transformed message. If a 'lambda' activity is specified,
997
+ # only short-running Lambda functions (those with a timeout of less than
998
+ # 30 seconds or less) can be used.
999
+ #
1000
+ # @option params [required, Array<String, IO>] :payloads
1001
+ # The sample message payloads on which the pipeline activity is run.
1002
+ #
1003
+ # @return [Types::RunPipelineActivityResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1004
+ #
1005
+ # * {Types::RunPipelineActivityResponse#payloads #payloads} => Array&lt;String&gt;
1006
+ # * {Types::RunPipelineActivityResponse#log_result #log_result} => String
1007
+ #
1008
+ # @example Request syntax with placeholder values
1009
+ #
1010
+ # resp = client.run_pipeline_activity({
1011
+ # pipeline_activity: { # required
1012
+ # channel: {
1013
+ # name: "ActivityName", # required
1014
+ # channel_name: "ChannelName", # required
1015
+ # next: "ActivityName",
1016
+ # },
1017
+ # lambda: {
1018
+ # name: "ActivityName", # required
1019
+ # lambda_name: "LambdaName", # required
1020
+ # batch_size: 1, # required
1021
+ # next: "ActivityName",
1022
+ # },
1023
+ # datastore: {
1024
+ # name: "ActivityName", # required
1025
+ # datastore_name: "DatastoreName", # required
1026
+ # },
1027
+ # add_attributes: {
1028
+ # name: "ActivityName", # required
1029
+ # attributes: { # required
1030
+ # "AttributeName" => "AttributeName",
1031
+ # },
1032
+ # next: "ActivityName",
1033
+ # },
1034
+ # remove_attributes: {
1035
+ # name: "ActivityName", # required
1036
+ # attributes: ["AttributeName"], # required
1037
+ # next: "ActivityName",
1038
+ # },
1039
+ # select_attributes: {
1040
+ # name: "ActivityName", # required
1041
+ # attributes: ["AttributeName"], # required
1042
+ # next: "ActivityName",
1043
+ # },
1044
+ # filter: {
1045
+ # name: "ActivityName", # required
1046
+ # filter: "FilterExpression", # required
1047
+ # next: "ActivityName",
1048
+ # },
1049
+ # math: {
1050
+ # name: "ActivityName", # required
1051
+ # attribute: "AttributeName", # required
1052
+ # math: "MathExpression", # required
1053
+ # next: "ActivityName",
1054
+ # },
1055
+ # device_registry_enrich: {
1056
+ # name: "ActivityName", # required
1057
+ # attribute: "AttributeName", # required
1058
+ # thing_name: "AttributeName", # required
1059
+ # role_arn: "RoleArn", # required
1060
+ # next: "ActivityName",
1061
+ # },
1062
+ # device_shadow_enrich: {
1063
+ # name: "ActivityName", # required
1064
+ # attribute: "AttributeName", # required
1065
+ # thing_name: "AttributeName", # required
1066
+ # role_arn: "RoleArn", # required
1067
+ # next: "ActivityName",
1068
+ # },
1069
+ # },
1070
+ # payloads: ["data"], # required
1071
+ # })
1072
+ #
1073
+ # @example Response structure
1074
+ #
1075
+ # resp.payloads #=> Array
1076
+ # resp.payloads[0] #=> String
1077
+ # resp.log_result #=> String
1078
+ #
1079
+ # @overload run_pipeline_activity(params = {})
1080
+ # @param [Hash] params ({})
1081
+ def run_pipeline_activity(params = {}, options = {})
1082
+ req = build_request(:run_pipeline_activity, params)
1083
+ req.send_request(options)
1084
+ end
1085
+
1086
+ # Retrieves a sample of messages from the specified channel ingested
1087
+ # during the specified timeframe. Up to 10 messages can be retrieved.
1088
+ #
1089
+ # @option params [required, String] :channel_name
1090
+ # The name of the channel whose message samples are retrieved.
1091
+ #
1092
+ # @option params [Integer] :max_messages
1093
+ # The number of sample messages to be retrieved. The limit is 10, the
1094
+ # default is also 10.
1095
+ #
1096
+ # @option params [Time,DateTime,Date,Integer,String] :start_time
1097
+ # The start of the time window from which sample messages are retrieved.
1098
+ #
1099
+ # @option params [Time,DateTime,Date,Integer,String] :end_time
1100
+ # The end of the time window from which sample messages are retrieved.
1101
+ #
1102
+ # @return [Types::SampleChannelDataResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1103
+ #
1104
+ # * {Types::SampleChannelDataResponse#payloads #payloads} => Array&lt;String&gt;
1105
+ #
1106
+ # @example Request syntax with placeholder values
1107
+ #
1108
+ # resp = client.sample_channel_data({
1109
+ # channel_name: "ChannelName", # required
1110
+ # max_messages: 1,
1111
+ # start_time: Time.now,
1112
+ # end_time: Time.now,
1113
+ # })
1114
+ #
1115
+ # @example Response structure
1116
+ #
1117
+ # resp.payloads #=> Array
1118
+ # resp.payloads[0] #=> String
1119
+ #
1120
+ # @overload sample_channel_data(params = {})
1121
+ # @param [Hash] params ({})
1122
+ def sample_channel_data(params = {}, options = {})
1123
+ req = build_request(:sample_channel_data, params)
1124
+ req.send_request(options)
1125
+ end
1126
+
1127
+ # Starts the reprocessing of raw message data through the pipeline.
1128
+ #
1129
+ # @option params [required, String] :pipeline_name
1130
+ # The name of the pipeline on which to start reprocessing.
1131
+ #
1132
+ # @option params [Time,DateTime,Date,Integer,String] :start_time
1133
+ # The start time (inclusive) of raw message data that is reprocessed.
1134
+ #
1135
+ # @option params [Time,DateTime,Date,Integer,String] :end_time
1136
+ # The end time (exclusive) of raw message data that is reprocessed.
1137
+ #
1138
+ # @return [Types::StartPipelineReprocessingResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1139
+ #
1140
+ # * {Types::StartPipelineReprocessingResponse#reprocessing_id #reprocessing_id} => String
1141
+ #
1142
+ # @example Request syntax with placeholder values
1143
+ #
1144
+ # resp = client.start_pipeline_reprocessing({
1145
+ # pipeline_name: "PipelineName", # required
1146
+ # start_time: Time.now,
1147
+ # end_time: Time.now,
1148
+ # })
1149
+ #
1150
+ # @example Response structure
1151
+ #
1152
+ # resp.reprocessing_id #=> String
1153
+ #
1154
+ # @overload start_pipeline_reprocessing(params = {})
1155
+ # @param [Hash] params ({})
1156
+ def start_pipeline_reprocessing(params = {}, options = {})
1157
+ req = build_request(:start_pipeline_reprocessing, params)
1158
+ req.send_request(options)
1159
+ end
1160
+
1161
+ # Updates the settings of a channel.
1162
+ #
1163
+ # @option params [required, String] :channel_name
1164
+ # The name of the channel to be updated.
1165
+ #
1166
+ # @option params [Types::RetentionPeriod] :retention_period
1167
+ # How long, in days, message data is kept for the channel.
1168
+ #
1169
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1170
+ #
1171
+ # @example Request syntax with placeholder values
1172
+ #
1173
+ # resp = client.update_channel({
1174
+ # channel_name: "ChannelName", # required
1175
+ # retention_period: {
1176
+ # unlimited: false,
1177
+ # number_of_days: 1,
1178
+ # },
1179
+ # })
1180
+ #
1181
+ # @overload update_channel(params = {})
1182
+ # @param [Hash] params ({})
1183
+ def update_channel(params = {}, options = {})
1184
+ req = build_request(:update_channel, params)
1185
+ req.send_request(options)
1186
+ end
1187
+
1188
+ # Updates the settings of a data set.
1189
+ #
1190
+ # @option params [required, String] :dataset_name
1191
+ # The name of the data set to update.
1192
+ #
1193
+ # @option params [required, Array<Types::DatasetAction>] :actions
1194
+ # A list of "DatasetAction" objects. Only one action is supported at
1195
+ # this time.
1196
+ #
1197
+ # @option params [Array<Types::DatasetTrigger>] :triggers
1198
+ # A list of "DatasetTrigger" objects. The list can be empty or can
1199
+ # contain up to five **DataSetTrigger** objects.
1200
+ #
1201
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1202
+ #
1203
+ # @example Request syntax with placeholder values
1204
+ #
1205
+ # resp = client.update_dataset({
1206
+ # dataset_name: "DatasetName", # required
1207
+ # actions: [ # required
1208
+ # {
1209
+ # action_name: "DatasetActionName",
1210
+ # query_action: {
1211
+ # sql_query: "SqlQuery", # required
1212
+ # },
1213
+ # },
1214
+ # ],
1215
+ # triggers: [
1216
+ # {
1217
+ # schedule: {
1218
+ # expression: "ScheduleExpression",
1219
+ # },
1220
+ # },
1221
+ # ],
1222
+ # })
1223
+ #
1224
+ # @overload update_dataset(params = {})
1225
+ # @param [Hash] params ({})
1226
+ def update_dataset(params = {}, options = {})
1227
+ req = build_request(:update_dataset, params)
1228
+ req.send_request(options)
1229
+ end
1230
+
1231
+ # Updates the settings of a data store.
1232
+ #
1233
+ # @option params [required, String] :datastore_name
1234
+ # The name of the data store to be updated.
1235
+ #
1236
+ # @option params [Types::RetentionPeriod] :retention_period
1237
+ # How long, in days, message data is kept for the data store.
1238
+ #
1239
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1240
+ #
1241
+ # @example Request syntax with placeholder values
1242
+ #
1243
+ # resp = client.update_datastore({
1244
+ # datastore_name: "DatastoreName", # required
1245
+ # retention_period: {
1246
+ # unlimited: false,
1247
+ # number_of_days: 1,
1248
+ # },
1249
+ # })
1250
+ #
1251
+ # @overload update_datastore(params = {})
1252
+ # @param [Hash] params ({})
1253
+ def update_datastore(params = {}, options = {})
1254
+ req = build_request(:update_datastore, params)
1255
+ req.send_request(options)
1256
+ end
1257
+
1258
+ # Updates the settings of a pipeline.
1259
+ #
1260
+ # @option params [required, String] :pipeline_name
1261
+ # The name of the pipeline to update.
1262
+ #
1263
+ # @option params [required, Array<Types::PipelineActivity>] :pipeline_activities
1264
+ # A list of "PipelineActivity" objects.
1265
+ #
1266
+ # The list can be 1-25 **PipelineActivity** objects. Activities perform
1267
+ # transformations on your messages, such as removing, renaming or adding
1268
+ # message attributes; filtering messages based on attribute values;
1269
+ # invoking your Lambda functions on messages for advanced processing; or
1270
+ # performing mathematical transformations to normalize device data.
1271
+ #
1272
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1273
+ #
1274
+ # @example Request syntax with placeholder values
1275
+ #
1276
+ # resp = client.update_pipeline({
1277
+ # pipeline_name: "PipelineName", # required
1278
+ # pipeline_activities: [ # required
1279
+ # {
1280
+ # channel: {
1281
+ # name: "ActivityName", # required
1282
+ # channel_name: "ChannelName", # required
1283
+ # next: "ActivityName",
1284
+ # },
1285
+ # lambda: {
1286
+ # name: "ActivityName", # required
1287
+ # lambda_name: "LambdaName", # required
1288
+ # batch_size: 1, # required
1289
+ # next: "ActivityName",
1290
+ # },
1291
+ # datastore: {
1292
+ # name: "ActivityName", # required
1293
+ # datastore_name: "DatastoreName", # required
1294
+ # },
1295
+ # add_attributes: {
1296
+ # name: "ActivityName", # required
1297
+ # attributes: { # required
1298
+ # "AttributeName" => "AttributeName",
1299
+ # },
1300
+ # next: "ActivityName",
1301
+ # },
1302
+ # remove_attributes: {
1303
+ # name: "ActivityName", # required
1304
+ # attributes: ["AttributeName"], # required
1305
+ # next: "ActivityName",
1306
+ # },
1307
+ # select_attributes: {
1308
+ # name: "ActivityName", # required
1309
+ # attributes: ["AttributeName"], # required
1310
+ # next: "ActivityName",
1311
+ # },
1312
+ # filter: {
1313
+ # name: "ActivityName", # required
1314
+ # filter: "FilterExpression", # required
1315
+ # next: "ActivityName",
1316
+ # },
1317
+ # math: {
1318
+ # name: "ActivityName", # required
1319
+ # attribute: "AttributeName", # required
1320
+ # math: "MathExpression", # required
1321
+ # next: "ActivityName",
1322
+ # },
1323
+ # device_registry_enrich: {
1324
+ # name: "ActivityName", # required
1325
+ # attribute: "AttributeName", # required
1326
+ # thing_name: "AttributeName", # required
1327
+ # role_arn: "RoleArn", # required
1328
+ # next: "ActivityName",
1329
+ # },
1330
+ # device_shadow_enrich: {
1331
+ # name: "ActivityName", # required
1332
+ # attribute: "AttributeName", # required
1333
+ # thing_name: "AttributeName", # required
1334
+ # role_arn: "RoleArn", # required
1335
+ # next: "ActivityName",
1336
+ # },
1337
+ # },
1338
+ # ],
1339
+ # })
1340
+ #
1341
+ # @overload update_pipeline(params = {})
1342
+ # @param [Hash] params ({})
1343
+ def update_pipeline(params = {}, options = {})
1344
+ req = build_request(:update_pipeline, params)
1345
+ req.send_request(options)
1346
+ end
1347
+
1348
+ # @!endgroup
1349
+
1350
+ # @param params ({})
1351
+ # @api private
1352
+ def build_request(operation_name, params = {})
1353
+ handlers = @handlers.for(operation_name)
1354
+ context = Seahorse::Client::RequestContext.new(
1355
+ operation_name: operation_name,
1356
+ operation: config.api.operation(operation_name),
1357
+ client: self,
1358
+ params: params,
1359
+ config: config)
1360
+ context[:gem_name] = 'aws-sdk-iotanalytics'
1361
+ context[:gem_version] = '1.0.0'
1362
+ Seahorse::Client::Request.new(handlers, context)
1363
+ end
1364
+
1365
+ # @api private
1366
+ # @deprecated
1367
+ def waiter_names
1368
+ []
1369
+ end
1370
+
1371
+ class << self
1372
+
1373
+ # @api private
1374
+ attr_reader :identifier
1375
+
1376
+ # @api private
1377
+ def errors_module
1378
+ Errors
1379
+ end
1380
+
1381
+ end
1382
+ end
1383
+ end