aws-sdk-iotanalytics 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,14 @@
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
+ module Aws::IoTAnalytics
9
+ module Errors
10
+
11
+ extend Aws::Errors::DynamicErrors
12
+
13
+ end
14
+ end
@@ -0,0 +1,23 @@
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
+ module Aws::IoTAnalytics
9
+ class Resource
10
+
11
+ # @param options ({})
12
+ # @option options [Client] :client
13
+ def initialize(options = {})
14
+ @client = options[:client] || Client.new(options)
15
+ end
16
+
17
+ # @return [Client]
18
+ def client
19
+ @client
20
+ end
21
+
22
+ end
23
+ end
@@ -0,0 +1,2120 @@
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
+ module Aws::IoTAnalytics
9
+ module Types
10
+
11
+ # An activity that adds other attributes based on existing attributes in
12
+ # the message.
13
+ #
14
+ # @note When making an API call, you may pass AddAttributesActivity
15
+ # data as a hash:
16
+ #
17
+ # {
18
+ # name: "ActivityName", # required
19
+ # attributes: { # required
20
+ # "AttributeName" => "AttributeName",
21
+ # },
22
+ # next: "ActivityName",
23
+ # }
24
+ #
25
+ # @!attribute [rw] name
26
+ # The name of the 'addAttributes' activity.
27
+ # @return [String]
28
+ #
29
+ # @!attribute [rw] attributes
30
+ # A list of 1-50 "AttributeNameMapping" objects that map an existing
31
+ # attribute to a new attribute.
32
+ #
33
+ # <note markdown="1"> The existing attributes remain in the message, so if you want to
34
+ # remove the originals, use "RemoveAttributeActivity".
35
+ #
36
+ # </note>
37
+ # @return [Hash<String,String>]
38
+ #
39
+ # @!attribute [rw] next
40
+ # The next activity in the pipeline.
41
+ # @return [String]
42
+ #
43
+ class AddAttributesActivity < Struct.new(
44
+ :name,
45
+ :attributes,
46
+ :next)
47
+ include Aws::Structure
48
+ end
49
+
50
+ # Contains informations about errors.
51
+ #
52
+ # @!attribute [rw] message_id
53
+ # The ID of the message that caused the error. (See the value
54
+ # corresponding to the "messageId" key in the message object.)
55
+ # @return [String]
56
+ #
57
+ # @!attribute [rw] error_code
58
+ # The code associated with the error.
59
+ # @return [String]
60
+ #
61
+ # @!attribute [rw] error_message
62
+ # The message associated with the error.
63
+ # @return [String]
64
+ #
65
+ class BatchPutMessageErrorEntry < Struct.new(
66
+ :message_id,
67
+ :error_code,
68
+ :error_message)
69
+ include Aws::Structure
70
+ end
71
+
72
+ # @note When making an API call, you may pass BatchPutMessageRequest
73
+ # data as a hash:
74
+ #
75
+ # {
76
+ # channel_name: "ChannelName", # required
77
+ # messages: [ # required
78
+ # {
79
+ # message_id: "MessageId", # required
80
+ # payload: "data", # required
81
+ # },
82
+ # ],
83
+ # }
84
+ #
85
+ # @!attribute [rw] channel_name
86
+ # The name of the channel where the messages are sent.
87
+ # @return [String]
88
+ #
89
+ # @!attribute [rw] messages
90
+ # The list of messages to be sent. Each message has format: '\\\{
91
+ # "messageId": "string", "payload": "string"\\}'.
92
+ # @return [Array<Types::Message>]
93
+ #
94
+ class BatchPutMessageRequest < Struct.new(
95
+ :channel_name,
96
+ :messages)
97
+ include Aws::Structure
98
+ end
99
+
100
+ # @!attribute [rw] batch_put_message_error_entries
101
+ # A list of any errors encountered when sending the messages to the
102
+ # channel.
103
+ # @return [Array<Types::BatchPutMessageErrorEntry>]
104
+ #
105
+ class BatchPutMessageResponse < Struct.new(
106
+ :batch_put_message_error_entries)
107
+ include Aws::Structure
108
+ end
109
+
110
+ # @note When making an API call, you may pass CancelPipelineReprocessingRequest
111
+ # data as a hash:
112
+ #
113
+ # {
114
+ # pipeline_name: "PipelineName", # required
115
+ # reprocessing_id: "ReprocessingId", # required
116
+ # }
117
+ #
118
+ # @!attribute [rw] pipeline_name
119
+ # The name of pipeline for which data reprocessing is canceled.
120
+ # @return [String]
121
+ #
122
+ # @!attribute [rw] reprocessing_id
123
+ # The ID of the reprocessing task (returned by
124
+ # "StartPipelineReprocessing").
125
+ # @return [String]
126
+ #
127
+ class CancelPipelineReprocessingRequest < Struct.new(
128
+ :pipeline_name,
129
+ :reprocessing_id)
130
+ include Aws::Structure
131
+ end
132
+
133
+ class CancelPipelineReprocessingResponse < Aws::EmptyStructure; end
134
+
135
+ # A collection of data from an MQTT topic. Channels archive the raw,
136
+ # unprocessed messages before publishing the data to a pipeline.
137
+ #
138
+ # @!attribute [rw] name
139
+ # The name of the channel.
140
+ # @return [String]
141
+ #
142
+ # @!attribute [rw] arn
143
+ # The ARN of the channel.
144
+ # @return [String]
145
+ #
146
+ # @!attribute [rw] status
147
+ # The status of the channel.
148
+ # @return [String]
149
+ #
150
+ # @!attribute [rw] retention_period
151
+ # How long, in days, message data is kept for the channel.
152
+ # @return [Types::RetentionPeriod]
153
+ #
154
+ # @!attribute [rw] creation_time
155
+ # When the channel was created.
156
+ # @return [Time]
157
+ #
158
+ # @!attribute [rw] last_update_time
159
+ # When the channel was last updated.
160
+ # @return [Time]
161
+ #
162
+ class Channel < Struct.new(
163
+ :name,
164
+ :arn,
165
+ :status,
166
+ :retention_period,
167
+ :creation_time,
168
+ :last_update_time)
169
+ include Aws::Structure
170
+ end
171
+
172
+ # The activity that determines the source of the messages to be
173
+ # processed.
174
+ #
175
+ # @note When making an API call, you may pass ChannelActivity
176
+ # data as a hash:
177
+ #
178
+ # {
179
+ # name: "ActivityName", # required
180
+ # channel_name: "ChannelName", # required
181
+ # next: "ActivityName",
182
+ # }
183
+ #
184
+ # @!attribute [rw] name
185
+ # The name of the 'channel' activity.
186
+ # @return [String]
187
+ #
188
+ # @!attribute [rw] channel_name
189
+ # The name of the channel from which the messages are processed.
190
+ # @return [String]
191
+ #
192
+ # @!attribute [rw] next
193
+ # The next activity in the pipeline.
194
+ # @return [String]
195
+ #
196
+ class ChannelActivity < Struct.new(
197
+ :name,
198
+ :channel_name,
199
+ :next)
200
+ include Aws::Structure
201
+ end
202
+
203
+ # A summary of information about a channel.
204
+ #
205
+ # @!attribute [rw] channel_name
206
+ # The name of the channel.
207
+ # @return [String]
208
+ #
209
+ # @!attribute [rw] status
210
+ # The status of the channel.
211
+ # @return [String]
212
+ #
213
+ # @!attribute [rw] creation_time
214
+ # When the channel was created.
215
+ # @return [Time]
216
+ #
217
+ # @!attribute [rw] last_update_time
218
+ # The last time the channel was updated.
219
+ # @return [Time]
220
+ #
221
+ class ChannelSummary < Struct.new(
222
+ :channel_name,
223
+ :status,
224
+ :creation_time,
225
+ :last_update_time)
226
+ include Aws::Structure
227
+ end
228
+
229
+ # @note When making an API call, you may pass CreateChannelRequest
230
+ # data as a hash:
231
+ #
232
+ # {
233
+ # channel_name: "ChannelName", # required
234
+ # retention_period: {
235
+ # unlimited: false,
236
+ # number_of_days: 1,
237
+ # },
238
+ # }
239
+ #
240
+ # @!attribute [rw] channel_name
241
+ # The name of the channel.
242
+ # @return [String]
243
+ #
244
+ # @!attribute [rw] retention_period
245
+ # How long, in days, message data is kept for the channel.
246
+ # @return [Types::RetentionPeriod]
247
+ #
248
+ class CreateChannelRequest < Struct.new(
249
+ :channel_name,
250
+ :retention_period)
251
+ include Aws::Structure
252
+ end
253
+
254
+ # @!attribute [rw] channel_name
255
+ # The name of the channel.
256
+ # @return [String]
257
+ #
258
+ # @!attribute [rw] channel_arn
259
+ # The ARN of the channel.
260
+ # @return [String]
261
+ #
262
+ # @!attribute [rw] retention_period
263
+ # How long, in days, message data is kept for the channel.
264
+ # @return [Types::RetentionPeriod]
265
+ #
266
+ class CreateChannelResponse < Struct.new(
267
+ :channel_name,
268
+ :channel_arn,
269
+ :retention_period)
270
+ include Aws::Structure
271
+ end
272
+
273
+ # @note When making an API call, you may pass CreateDatasetContentRequest
274
+ # data as a hash:
275
+ #
276
+ # {
277
+ # dataset_name: "DatasetName", # required
278
+ # }
279
+ #
280
+ # @!attribute [rw] dataset_name
281
+ # The name of the data set.
282
+ # @return [String]
283
+ #
284
+ class CreateDatasetContentRequest < Struct.new(
285
+ :dataset_name)
286
+ include Aws::Structure
287
+ end
288
+
289
+ # @note When making an API call, you may pass CreateDatasetRequest
290
+ # data as a hash:
291
+ #
292
+ # {
293
+ # dataset_name: "DatasetName", # required
294
+ # actions: [ # required
295
+ # {
296
+ # action_name: "DatasetActionName",
297
+ # query_action: {
298
+ # sql_query: "SqlQuery", # required
299
+ # },
300
+ # },
301
+ # ],
302
+ # triggers: [
303
+ # {
304
+ # schedule: {
305
+ # expression: "ScheduleExpression",
306
+ # },
307
+ # },
308
+ # ],
309
+ # }
310
+ #
311
+ # @!attribute [rw] dataset_name
312
+ # The name of the data set.
313
+ # @return [String]
314
+ #
315
+ # @!attribute [rw] actions
316
+ # A list of actions that create the data set. Only one action is
317
+ # supported at this time.
318
+ # @return [Array<Types::DatasetAction>]
319
+ #
320
+ # @!attribute [rw] triggers
321
+ # A list of triggers. A trigger causes data set content to be
322
+ # populated at a specified time or time interval. The list of triggers
323
+ # can be empty or contain up to five **DataSetTrigger** objects.
324
+ # @return [Array<Types::DatasetTrigger>]
325
+ #
326
+ class CreateDatasetRequest < Struct.new(
327
+ :dataset_name,
328
+ :actions,
329
+ :triggers)
330
+ include Aws::Structure
331
+ end
332
+
333
+ # @!attribute [rw] dataset_name
334
+ # The name of the data set.
335
+ # @return [String]
336
+ #
337
+ # @!attribute [rw] dataset_arn
338
+ # The ARN of the data set.
339
+ # @return [String]
340
+ #
341
+ class CreateDatasetResponse < Struct.new(
342
+ :dataset_name,
343
+ :dataset_arn)
344
+ include Aws::Structure
345
+ end
346
+
347
+ # @note When making an API call, you may pass CreateDatastoreRequest
348
+ # data as a hash:
349
+ #
350
+ # {
351
+ # datastore_name: "DatastoreName", # required
352
+ # retention_period: {
353
+ # unlimited: false,
354
+ # number_of_days: 1,
355
+ # },
356
+ # }
357
+ #
358
+ # @!attribute [rw] datastore_name
359
+ # The name of the data store.
360
+ # @return [String]
361
+ #
362
+ # @!attribute [rw] retention_period
363
+ # How long, in days, message data is kept for the data store.
364
+ # @return [Types::RetentionPeriod]
365
+ #
366
+ class CreateDatastoreRequest < Struct.new(
367
+ :datastore_name,
368
+ :retention_period)
369
+ include Aws::Structure
370
+ end
371
+
372
+ # @!attribute [rw] datastore_name
373
+ # The name of the data store.
374
+ # @return [String]
375
+ #
376
+ # @!attribute [rw] datastore_arn
377
+ # The ARN of the data store.
378
+ # @return [String]
379
+ #
380
+ # @!attribute [rw] retention_period
381
+ # How long, in days, message data is kept for the data store.
382
+ # @return [Types::RetentionPeriod]
383
+ #
384
+ class CreateDatastoreResponse < Struct.new(
385
+ :datastore_name,
386
+ :datastore_arn,
387
+ :retention_period)
388
+ include Aws::Structure
389
+ end
390
+
391
+ # @note When making an API call, you may pass CreatePipelineRequest
392
+ # data as a hash:
393
+ #
394
+ # {
395
+ # pipeline_name: "PipelineName", # required
396
+ # pipeline_activities: [ # required
397
+ # {
398
+ # channel: {
399
+ # name: "ActivityName", # required
400
+ # channel_name: "ChannelName", # required
401
+ # next: "ActivityName",
402
+ # },
403
+ # lambda: {
404
+ # name: "ActivityName", # required
405
+ # lambda_name: "LambdaName", # required
406
+ # batch_size: 1, # required
407
+ # next: "ActivityName",
408
+ # },
409
+ # datastore: {
410
+ # name: "ActivityName", # required
411
+ # datastore_name: "DatastoreName", # required
412
+ # },
413
+ # add_attributes: {
414
+ # name: "ActivityName", # required
415
+ # attributes: { # required
416
+ # "AttributeName" => "AttributeName",
417
+ # },
418
+ # next: "ActivityName",
419
+ # },
420
+ # remove_attributes: {
421
+ # name: "ActivityName", # required
422
+ # attributes: ["AttributeName"], # required
423
+ # next: "ActivityName",
424
+ # },
425
+ # select_attributes: {
426
+ # name: "ActivityName", # required
427
+ # attributes: ["AttributeName"], # required
428
+ # next: "ActivityName",
429
+ # },
430
+ # filter: {
431
+ # name: "ActivityName", # required
432
+ # filter: "FilterExpression", # required
433
+ # next: "ActivityName",
434
+ # },
435
+ # math: {
436
+ # name: "ActivityName", # required
437
+ # attribute: "AttributeName", # required
438
+ # math: "MathExpression", # required
439
+ # next: "ActivityName",
440
+ # },
441
+ # device_registry_enrich: {
442
+ # name: "ActivityName", # required
443
+ # attribute: "AttributeName", # required
444
+ # thing_name: "AttributeName", # required
445
+ # role_arn: "RoleArn", # required
446
+ # next: "ActivityName",
447
+ # },
448
+ # device_shadow_enrich: {
449
+ # name: "ActivityName", # required
450
+ # attribute: "AttributeName", # required
451
+ # thing_name: "AttributeName", # required
452
+ # role_arn: "RoleArn", # required
453
+ # next: "ActivityName",
454
+ # },
455
+ # },
456
+ # ],
457
+ # }
458
+ #
459
+ # @!attribute [rw] pipeline_name
460
+ # The name of the pipeline.
461
+ # @return [String]
462
+ #
463
+ # @!attribute [rw] pipeline_activities
464
+ # A list of pipeline activities.
465
+ #
466
+ # The list can be 1-25 **PipelineActivity** objects. Activities
467
+ # perform transformations on your messages, such as removing,
468
+ # renaming, or adding message attributes; filtering messages based on
469
+ # attribute values; invoking your Lambda functions on messages for
470
+ # advanced processing; or performing mathematical transformations to
471
+ # normalize device data.
472
+ # @return [Array<Types::PipelineActivity>]
473
+ #
474
+ class CreatePipelineRequest < Struct.new(
475
+ :pipeline_name,
476
+ :pipeline_activities)
477
+ include Aws::Structure
478
+ end
479
+
480
+ # @!attribute [rw] pipeline_name
481
+ # The name of the pipeline.
482
+ # @return [String]
483
+ #
484
+ # @!attribute [rw] pipeline_arn
485
+ # The ARN of the pipeline.
486
+ # @return [String]
487
+ #
488
+ class CreatePipelineResponse < Struct.new(
489
+ :pipeline_name,
490
+ :pipeline_arn)
491
+ include Aws::Structure
492
+ end
493
+
494
+ # Information about a data set.
495
+ #
496
+ # @!attribute [rw] name
497
+ # The name of the data set.
498
+ # @return [String]
499
+ #
500
+ # @!attribute [rw] arn
501
+ # The ARN of the data set.
502
+ # @return [String]
503
+ #
504
+ # @!attribute [rw] actions
505
+ # The "DatasetAction" objects that create the data set.
506
+ # @return [Array<Types::DatasetAction>]
507
+ #
508
+ # @!attribute [rw] triggers
509
+ # The "DatasetTrigger" objects that specify when the data set is
510
+ # automatically updated.
511
+ # @return [Array<Types::DatasetTrigger>]
512
+ #
513
+ # @!attribute [rw] status
514
+ # The status of the data set.
515
+ # @return [String]
516
+ #
517
+ # @!attribute [rw] creation_time
518
+ # When the data set was created.
519
+ # @return [Time]
520
+ #
521
+ # @!attribute [rw] last_update_time
522
+ # The last time the data set was updated.
523
+ # @return [Time]
524
+ #
525
+ class Dataset < Struct.new(
526
+ :name,
527
+ :arn,
528
+ :actions,
529
+ :triggers,
530
+ :status,
531
+ :creation_time,
532
+ :last_update_time)
533
+ include Aws::Structure
534
+ end
535
+
536
+ # A "DatasetAction" object specifying the query that creates the data
537
+ # set content.
538
+ #
539
+ # @note When making an API call, you may pass DatasetAction
540
+ # data as a hash:
541
+ #
542
+ # {
543
+ # action_name: "DatasetActionName",
544
+ # query_action: {
545
+ # sql_query: "SqlQuery", # required
546
+ # },
547
+ # }
548
+ #
549
+ # @!attribute [rw] action_name
550
+ # The name of the data set action.
551
+ # @return [String]
552
+ #
553
+ # @!attribute [rw] query_action
554
+ # An "SqlQueryDatasetAction" object that contains the SQL query to
555
+ # modify the message.
556
+ # @return [Types::SqlQueryDatasetAction]
557
+ #
558
+ class DatasetAction < Struct.new(
559
+ :action_name,
560
+ :query_action)
561
+ include Aws::Structure
562
+ end
563
+
564
+ # The state of the data set and the reason it is in this state.
565
+ #
566
+ # @!attribute [rw] state
567
+ # The state of the data set. Can be one of "CREATING", "SUCCEEDED"
568
+ # or "FAILED".
569
+ # @return [String]
570
+ #
571
+ # @!attribute [rw] reason
572
+ # The reason the data set is in this state.
573
+ # @return [String]
574
+ #
575
+ class DatasetContentStatus < Struct.new(
576
+ :state,
577
+ :reason)
578
+ include Aws::Structure
579
+ end
580
+
581
+ # The reference to a data set entry.
582
+ #
583
+ # @!attribute [rw] entry_name
584
+ # The name of the data set item.
585
+ # @return [String]
586
+ #
587
+ # @!attribute [rw] data_uri
588
+ # The pre-signed URI of the data set item.
589
+ # @return [String]
590
+ #
591
+ class DatasetEntry < Struct.new(
592
+ :entry_name,
593
+ :data_uri)
594
+ include Aws::Structure
595
+ end
596
+
597
+ # A summary of information about a data set.
598
+ #
599
+ # @!attribute [rw] dataset_name
600
+ # The name of the data set.
601
+ # @return [String]
602
+ #
603
+ # @!attribute [rw] status
604
+ # The status of the data set.
605
+ # @return [String]
606
+ #
607
+ # @!attribute [rw] creation_time
608
+ # The time the data set was created.
609
+ # @return [Time]
610
+ #
611
+ # @!attribute [rw] last_update_time
612
+ # The last time the data set was updated.
613
+ # @return [Time]
614
+ #
615
+ class DatasetSummary < Struct.new(
616
+ :dataset_name,
617
+ :status,
618
+ :creation_time,
619
+ :last_update_time)
620
+ include Aws::Structure
621
+ end
622
+
623
+ # The "DatasetTrigger" that specifies when the data set is
624
+ # automatically updated.
625
+ #
626
+ # @note When making an API call, you may pass DatasetTrigger
627
+ # data as a hash:
628
+ #
629
+ # {
630
+ # schedule: {
631
+ # expression: "ScheduleExpression",
632
+ # },
633
+ # }
634
+ #
635
+ # @!attribute [rw] schedule
636
+ # The "Schedule" when the trigger is initiated.
637
+ # @return [Types::Schedule]
638
+ #
639
+ class DatasetTrigger < Struct.new(
640
+ :schedule)
641
+ include Aws::Structure
642
+ end
643
+
644
+ # Information about a data store.
645
+ #
646
+ # @!attribute [rw] name
647
+ # The name of the data store.
648
+ # @return [String]
649
+ #
650
+ # @!attribute [rw] arn
651
+ # The ARN of the data store.
652
+ # @return [String]
653
+ #
654
+ # @!attribute [rw] status
655
+ # The status of a data store:
656
+ #
657
+ # CREATING
658
+ #
659
+ # : The data store is being created.
660
+ #
661
+ # ACTIVE
662
+ #
663
+ # : The data store has been created and can be used.
664
+ #
665
+ # DELETING
666
+ #
667
+ # : The data store is being deleted.
668
+ # @return [String]
669
+ #
670
+ # @!attribute [rw] retention_period
671
+ # How long, in days, message data is kept for the data store.
672
+ # @return [Types::RetentionPeriod]
673
+ #
674
+ # @!attribute [rw] creation_time
675
+ # When the data store was created.
676
+ # @return [Time]
677
+ #
678
+ # @!attribute [rw] last_update_time
679
+ # The last time the data store was updated.
680
+ # @return [Time]
681
+ #
682
+ class Datastore < Struct.new(
683
+ :name,
684
+ :arn,
685
+ :status,
686
+ :retention_period,
687
+ :creation_time,
688
+ :last_update_time)
689
+ include Aws::Structure
690
+ end
691
+
692
+ # The 'datastore' activity that specifies where to store the processed
693
+ # data.
694
+ #
695
+ # @note When making an API call, you may pass DatastoreActivity
696
+ # data as a hash:
697
+ #
698
+ # {
699
+ # name: "ActivityName", # required
700
+ # datastore_name: "DatastoreName", # required
701
+ # }
702
+ #
703
+ # @!attribute [rw] name
704
+ # The name of the 'datastore' activity.
705
+ # @return [String]
706
+ #
707
+ # @!attribute [rw] datastore_name
708
+ # The name of the data store where processed messages are stored.
709
+ # @return [String]
710
+ #
711
+ class DatastoreActivity < Struct.new(
712
+ :name,
713
+ :datastore_name)
714
+ include Aws::Structure
715
+ end
716
+
717
+ # A summary of information about a data store.
718
+ #
719
+ # @!attribute [rw] datastore_name
720
+ # The name of the data store.
721
+ # @return [String]
722
+ #
723
+ # @!attribute [rw] status
724
+ # The status of the data store.
725
+ # @return [String]
726
+ #
727
+ # @!attribute [rw] creation_time
728
+ # When the data store was created.
729
+ # @return [Time]
730
+ #
731
+ # @!attribute [rw] last_update_time
732
+ # The last time the data store was updated.
733
+ # @return [Time]
734
+ #
735
+ class DatastoreSummary < Struct.new(
736
+ :datastore_name,
737
+ :status,
738
+ :creation_time,
739
+ :last_update_time)
740
+ include Aws::Structure
741
+ end
742
+
743
+ # @note When making an API call, you may pass DeleteChannelRequest
744
+ # data as a hash:
745
+ #
746
+ # {
747
+ # channel_name: "ChannelName", # required
748
+ # }
749
+ #
750
+ # @!attribute [rw] channel_name
751
+ # The name of the channel to delete.
752
+ # @return [String]
753
+ #
754
+ class DeleteChannelRequest < Struct.new(
755
+ :channel_name)
756
+ include Aws::Structure
757
+ end
758
+
759
+ # @note When making an API call, you may pass DeleteDatasetContentRequest
760
+ # data as a hash:
761
+ #
762
+ # {
763
+ # dataset_name: "DatasetName", # required
764
+ # version_id: "DatasetContentVersion",
765
+ # }
766
+ #
767
+ # @!attribute [rw] dataset_name
768
+ # The name of the data set whose content is deleted.
769
+ # @return [String]
770
+ #
771
+ # @!attribute [rw] version_id
772
+ # The version of the data set whose content is deleted. You can also
773
+ # use the strings "$LATEST" or "$LATEST\_SUCCEEDED" to delete the
774
+ # latest or latest successfully completed data set. If not specified,
775
+ # "$LATEST\_SUCCEEDED" is the default.
776
+ # @return [String]
777
+ #
778
+ class DeleteDatasetContentRequest < Struct.new(
779
+ :dataset_name,
780
+ :version_id)
781
+ include Aws::Structure
782
+ end
783
+
784
+ # @note When making an API call, you may pass DeleteDatasetRequest
785
+ # data as a hash:
786
+ #
787
+ # {
788
+ # dataset_name: "DatasetName", # required
789
+ # }
790
+ #
791
+ # @!attribute [rw] dataset_name
792
+ # The name of the data set to delete.
793
+ # @return [String]
794
+ #
795
+ class DeleteDatasetRequest < Struct.new(
796
+ :dataset_name)
797
+ include Aws::Structure
798
+ end
799
+
800
+ # @note When making an API call, you may pass DeleteDatastoreRequest
801
+ # data as a hash:
802
+ #
803
+ # {
804
+ # datastore_name: "DatastoreName", # required
805
+ # }
806
+ #
807
+ # @!attribute [rw] datastore_name
808
+ # The name of the data store to delete.
809
+ # @return [String]
810
+ #
811
+ class DeleteDatastoreRequest < Struct.new(
812
+ :datastore_name)
813
+ include Aws::Structure
814
+ end
815
+
816
+ # @note When making an API call, you may pass DeletePipelineRequest
817
+ # data as a hash:
818
+ #
819
+ # {
820
+ # pipeline_name: "PipelineName", # required
821
+ # }
822
+ #
823
+ # @!attribute [rw] pipeline_name
824
+ # The name of the pipeline to delete.
825
+ # @return [String]
826
+ #
827
+ class DeletePipelineRequest < Struct.new(
828
+ :pipeline_name)
829
+ include Aws::Structure
830
+ end
831
+
832
+ # @note When making an API call, you may pass DescribeChannelRequest
833
+ # data as a hash:
834
+ #
835
+ # {
836
+ # channel_name: "ChannelName", # required
837
+ # }
838
+ #
839
+ # @!attribute [rw] channel_name
840
+ # The name of the channel whose information is retrieved.
841
+ # @return [String]
842
+ #
843
+ class DescribeChannelRequest < Struct.new(
844
+ :channel_name)
845
+ include Aws::Structure
846
+ end
847
+
848
+ # @!attribute [rw] channel
849
+ # An object that contains information about the channel.
850
+ # @return [Types::Channel]
851
+ #
852
+ class DescribeChannelResponse < Struct.new(
853
+ :channel)
854
+ include Aws::Structure
855
+ end
856
+
857
+ # @note When making an API call, you may pass DescribeDatasetRequest
858
+ # data as a hash:
859
+ #
860
+ # {
861
+ # dataset_name: "DatasetName", # required
862
+ # }
863
+ #
864
+ # @!attribute [rw] dataset_name
865
+ # The name of the data set whose information is retrieved.
866
+ # @return [String]
867
+ #
868
+ class DescribeDatasetRequest < Struct.new(
869
+ :dataset_name)
870
+ include Aws::Structure
871
+ end
872
+
873
+ # @!attribute [rw] dataset
874
+ # An object that contains information about the data set.
875
+ # @return [Types::Dataset]
876
+ #
877
+ class DescribeDatasetResponse < Struct.new(
878
+ :dataset)
879
+ include Aws::Structure
880
+ end
881
+
882
+ # @note When making an API call, you may pass DescribeDatastoreRequest
883
+ # data as a hash:
884
+ #
885
+ # {
886
+ # datastore_name: "DatastoreName", # required
887
+ # }
888
+ #
889
+ # @!attribute [rw] datastore_name
890
+ # The name of the data store
891
+ # @return [String]
892
+ #
893
+ class DescribeDatastoreRequest < Struct.new(
894
+ :datastore_name)
895
+ include Aws::Structure
896
+ end
897
+
898
+ # @!attribute [rw] datastore
899
+ # Information about the data store.
900
+ # @return [Types::Datastore]
901
+ #
902
+ class DescribeDatastoreResponse < Struct.new(
903
+ :datastore)
904
+ include Aws::Structure
905
+ end
906
+
907
+ # @api private
908
+ #
909
+ class DescribeLoggingOptionsRequest < Aws::EmptyStructure; end
910
+
911
+ # @!attribute [rw] logging_options
912
+ # The current settings of the AWS IoT Analytics logging options.
913
+ # @return [Types::LoggingOptions]
914
+ #
915
+ class DescribeLoggingOptionsResponse < Struct.new(
916
+ :logging_options)
917
+ include Aws::Structure
918
+ end
919
+
920
+ # @note When making an API call, you may pass DescribePipelineRequest
921
+ # data as a hash:
922
+ #
923
+ # {
924
+ # pipeline_name: "PipelineName", # required
925
+ # }
926
+ #
927
+ # @!attribute [rw] pipeline_name
928
+ # The name of the pipeline whose information is retrieved.
929
+ # @return [String]
930
+ #
931
+ class DescribePipelineRequest < Struct.new(
932
+ :pipeline_name)
933
+ include Aws::Structure
934
+ end
935
+
936
+ # @!attribute [rw] pipeline
937
+ # A "Pipeline" object that contains information about the pipeline.
938
+ # @return [Types::Pipeline]
939
+ #
940
+ class DescribePipelineResponse < Struct.new(
941
+ :pipeline)
942
+ include Aws::Structure
943
+ end
944
+
945
+ # An activity that adds data from the AWS IoT device registry to your
946
+ # message.
947
+ #
948
+ # @note When making an API call, you may pass DeviceRegistryEnrichActivity
949
+ # data as a hash:
950
+ #
951
+ # {
952
+ # name: "ActivityName", # required
953
+ # attribute: "AttributeName", # required
954
+ # thing_name: "AttributeName", # required
955
+ # role_arn: "RoleArn", # required
956
+ # next: "ActivityName",
957
+ # }
958
+ #
959
+ # @!attribute [rw] name
960
+ # The name of the 'deviceRegistryEnrich' activity.
961
+ # @return [String]
962
+ #
963
+ # @!attribute [rw] attribute
964
+ # The name of the attribute that is added to the message.
965
+ # @return [String]
966
+ #
967
+ # @!attribute [rw] thing_name
968
+ # The name of the IoT device whose registry information is added to
969
+ # the message.
970
+ # @return [String]
971
+ #
972
+ # @!attribute [rw] role_arn
973
+ # The ARN of the role that allows access to the device's registry
974
+ # information.
975
+ # @return [String]
976
+ #
977
+ # @!attribute [rw] next
978
+ # The next activity in the pipeline.
979
+ # @return [String]
980
+ #
981
+ class DeviceRegistryEnrichActivity < Struct.new(
982
+ :name,
983
+ :attribute,
984
+ :thing_name,
985
+ :role_arn,
986
+ :next)
987
+ include Aws::Structure
988
+ end
989
+
990
+ # An activity that adds information from the AWS IoT Device Shadows
991
+ # service to a message.
992
+ #
993
+ # @note When making an API call, you may pass DeviceShadowEnrichActivity
994
+ # data as a hash:
995
+ #
996
+ # {
997
+ # name: "ActivityName", # required
998
+ # attribute: "AttributeName", # required
999
+ # thing_name: "AttributeName", # required
1000
+ # role_arn: "RoleArn", # required
1001
+ # next: "ActivityName",
1002
+ # }
1003
+ #
1004
+ # @!attribute [rw] name
1005
+ # The name of the 'deviceShadowEnrich' activity.
1006
+ # @return [String]
1007
+ #
1008
+ # @!attribute [rw] attribute
1009
+ # The name of the attribute that is added to the message.
1010
+ # @return [String]
1011
+ #
1012
+ # @!attribute [rw] thing_name
1013
+ # The name of the IoT device whose shadow information is added to the
1014
+ # message.
1015
+ # @return [String]
1016
+ #
1017
+ # @!attribute [rw] role_arn
1018
+ # The ARN of the role that allows access to the device's shadow.
1019
+ # @return [String]
1020
+ #
1021
+ # @!attribute [rw] next
1022
+ # The next activity in the pipeline.
1023
+ # @return [String]
1024
+ #
1025
+ class DeviceShadowEnrichActivity < Struct.new(
1026
+ :name,
1027
+ :attribute,
1028
+ :thing_name,
1029
+ :role_arn,
1030
+ :next)
1031
+ include Aws::Structure
1032
+ end
1033
+
1034
+ # An activity that filters a message based on its attributes.
1035
+ #
1036
+ # @note When making an API call, you may pass FilterActivity
1037
+ # data as a hash:
1038
+ #
1039
+ # {
1040
+ # name: "ActivityName", # required
1041
+ # filter: "FilterExpression", # required
1042
+ # next: "ActivityName",
1043
+ # }
1044
+ #
1045
+ # @!attribute [rw] name
1046
+ # The name of the 'filter' activity.
1047
+ # @return [String]
1048
+ #
1049
+ # @!attribute [rw] filter
1050
+ # An expression that looks like an SQL WHERE clause that must return a
1051
+ # Boolean value.
1052
+ # @return [String]
1053
+ #
1054
+ # @!attribute [rw] next
1055
+ # The next activity in the pipeline.
1056
+ # @return [String]
1057
+ #
1058
+ class FilterActivity < Struct.new(
1059
+ :name,
1060
+ :filter,
1061
+ :next)
1062
+ include Aws::Structure
1063
+ end
1064
+
1065
+ # @note When making an API call, you may pass GetDatasetContentRequest
1066
+ # data as a hash:
1067
+ #
1068
+ # {
1069
+ # dataset_name: "DatasetName", # required
1070
+ # version_id: "DatasetContentVersion",
1071
+ # }
1072
+ #
1073
+ # @!attribute [rw] dataset_name
1074
+ # The name of the data set whose contents are retrieved.
1075
+ # @return [String]
1076
+ #
1077
+ # @!attribute [rw] version_id
1078
+ # The version of the data set whose contents are retrieved. You can
1079
+ # also use the strings "$LATEST" or "$LATEST\_SUCCEEDED" to
1080
+ # retrieve the contents of the latest or latest successfully completed
1081
+ # data set. If not specified, "$LATEST\_SUCCEEDED" is the default.
1082
+ # @return [String]
1083
+ #
1084
+ class GetDatasetContentRequest < Struct.new(
1085
+ :dataset_name,
1086
+ :version_id)
1087
+ include Aws::Structure
1088
+ end
1089
+
1090
+ # @!attribute [rw] entries
1091
+ # A list of "DatasetEntry" objects.
1092
+ # @return [Array<Types::DatasetEntry>]
1093
+ #
1094
+ # @!attribute [rw] timestamp
1095
+ # The time when the request was made.
1096
+ # @return [Time]
1097
+ #
1098
+ # @!attribute [rw] status
1099
+ # The status of the data set content.
1100
+ # @return [Types::DatasetContentStatus]
1101
+ #
1102
+ class GetDatasetContentResponse < Struct.new(
1103
+ :entries,
1104
+ :timestamp,
1105
+ :status)
1106
+ include Aws::Structure
1107
+ end
1108
+
1109
+ # An activity that runs a Lambda function to modify the message.
1110
+ #
1111
+ # @note When making an API call, you may pass LambdaActivity
1112
+ # data as a hash:
1113
+ #
1114
+ # {
1115
+ # name: "ActivityName", # required
1116
+ # lambda_name: "LambdaName", # required
1117
+ # batch_size: 1, # required
1118
+ # next: "ActivityName",
1119
+ # }
1120
+ #
1121
+ # @!attribute [rw] name
1122
+ # The name of the 'lambda' activity.
1123
+ # @return [String]
1124
+ #
1125
+ # @!attribute [rw] lambda_name
1126
+ # The name of the Lambda function that is run on the message.
1127
+ # @return [String]
1128
+ #
1129
+ # @!attribute [rw] batch_size
1130
+ # The number of messages passed to the Lambda function for processing.
1131
+ #
1132
+ # The AWS Lambda function must be able to process all of these
1133
+ # messages within five minutes, which is the maximum timeout duration
1134
+ # for Lambda functions.
1135
+ # @return [Integer]
1136
+ #
1137
+ # @!attribute [rw] next
1138
+ # The next activity in the pipeline.
1139
+ # @return [String]
1140
+ #
1141
+ class LambdaActivity < Struct.new(
1142
+ :name,
1143
+ :lambda_name,
1144
+ :batch_size,
1145
+ :next)
1146
+ include Aws::Structure
1147
+ end
1148
+
1149
+ # @note When making an API call, you may pass ListChannelsRequest
1150
+ # data as a hash:
1151
+ #
1152
+ # {
1153
+ # next_token: "NextToken",
1154
+ # max_results: 1,
1155
+ # }
1156
+ #
1157
+ # @!attribute [rw] next_token
1158
+ # The token for the next set of results.
1159
+ # @return [String]
1160
+ #
1161
+ # @!attribute [rw] max_results
1162
+ # The maximum number of results to return in this request.
1163
+ #
1164
+ # The default value is 100.
1165
+ # @return [Integer]
1166
+ #
1167
+ class ListChannelsRequest < Struct.new(
1168
+ :next_token,
1169
+ :max_results)
1170
+ include Aws::Structure
1171
+ end
1172
+
1173
+ # @!attribute [rw] channel_summaries
1174
+ # A list of "ChannelSummary" objects.
1175
+ # @return [Array<Types::ChannelSummary>]
1176
+ #
1177
+ # @!attribute [rw] next_token
1178
+ # The token to retrieve the next set of results, or `null` if there
1179
+ # are no more results.
1180
+ # @return [String]
1181
+ #
1182
+ class ListChannelsResponse < Struct.new(
1183
+ :channel_summaries,
1184
+ :next_token)
1185
+ include Aws::Structure
1186
+ end
1187
+
1188
+ # @note When making an API call, you may pass ListDatasetsRequest
1189
+ # data as a hash:
1190
+ #
1191
+ # {
1192
+ # next_token: "NextToken",
1193
+ # max_results: 1,
1194
+ # }
1195
+ #
1196
+ # @!attribute [rw] next_token
1197
+ # The token for the next set of results.
1198
+ # @return [String]
1199
+ #
1200
+ # @!attribute [rw] max_results
1201
+ # The maximum number of results to return in this request.
1202
+ #
1203
+ # The default value is 100.
1204
+ # @return [Integer]
1205
+ #
1206
+ class ListDatasetsRequest < Struct.new(
1207
+ :next_token,
1208
+ :max_results)
1209
+ include Aws::Structure
1210
+ end
1211
+
1212
+ # @!attribute [rw] dataset_summaries
1213
+ # A list of "DatasetSummary" objects.
1214
+ # @return [Array<Types::DatasetSummary>]
1215
+ #
1216
+ # @!attribute [rw] next_token
1217
+ # The token to retrieve the next set of results, or `null` if there
1218
+ # are no more results.
1219
+ # @return [String]
1220
+ #
1221
+ class ListDatasetsResponse < Struct.new(
1222
+ :dataset_summaries,
1223
+ :next_token)
1224
+ include Aws::Structure
1225
+ end
1226
+
1227
+ # @note When making an API call, you may pass ListDatastoresRequest
1228
+ # data as a hash:
1229
+ #
1230
+ # {
1231
+ # next_token: "NextToken",
1232
+ # max_results: 1,
1233
+ # }
1234
+ #
1235
+ # @!attribute [rw] next_token
1236
+ # The token for the next set of results.
1237
+ # @return [String]
1238
+ #
1239
+ # @!attribute [rw] max_results
1240
+ # The maximum number of results to return in this request.
1241
+ #
1242
+ # The default value is 100.
1243
+ # @return [Integer]
1244
+ #
1245
+ class ListDatastoresRequest < Struct.new(
1246
+ :next_token,
1247
+ :max_results)
1248
+ include Aws::Structure
1249
+ end
1250
+
1251
+ # @!attribute [rw] datastore_summaries
1252
+ # A list of "DatastoreSummary" objects.
1253
+ # @return [Array<Types::DatastoreSummary>]
1254
+ #
1255
+ # @!attribute [rw] next_token
1256
+ # The token to retrieve the next set of results, or `null` if there
1257
+ # are no more results.
1258
+ # @return [String]
1259
+ #
1260
+ class ListDatastoresResponse < Struct.new(
1261
+ :datastore_summaries,
1262
+ :next_token)
1263
+ include Aws::Structure
1264
+ end
1265
+
1266
+ # @note When making an API call, you may pass ListPipelinesRequest
1267
+ # data as a hash:
1268
+ #
1269
+ # {
1270
+ # next_token: "NextToken",
1271
+ # max_results: 1,
1272
+ # }
1273
+ #
1274
+ # @!attribute [rw] next_token
1275
+ # The token for the next set of results.
1276
+ # @return [String]
1277
+ #
1278
+ # @!attribute [rw] max_results
1279
+ # The maximum number of results to return in this request.
1280
+ #
1281
+ # The default value is 100.
1282
+ # @return [Integer]
1283
+ #
1284
+ class ListPipelinesRequest < Struct.new(
1285
+ :next_token,
1286
+ :max_results)
1287
+ include Aws::Structure
1288
+ end
1289
+
1290
+ # @!attribute [rw] pipeline_summaries
1291
+ # A list of "PipelineSummary" objects.
1292
+ # @return [Array<Types::PipelineSummary>]
1293
+ #
1294
+ # @!attribute [rw] next_token
1295
+ # The token to retrieve the next set of results, or `null` if there
1296
+ # are no more results.
1297
+ # @return [String]
1298
+ #
1299
+ class ListPipelinesResponse < Struct.new(
1300
+ :pipeline_summaries,
1301
+ :next_token)
1302
+ include Aws::Structure
1303
+ end
1304
+
1305
+ # Information about logging options.
1306
+ #
1307
+ # @note When making an API call, you may pass LoggingOptions
1308
+ # data as a hash:
1309
+ #
1310
+ # {
1311
+ # role_arn: "RoleArn", # required
1312
+ # level: "ERROR", # required, accepts ERROR
1313
+ # enabled: false, # required
1314
+ # }
1315
+ #
1316
+ # @!attribute [rw] role_arn
1317
+ # The ARN of the role that grants permission to AWS IoT Analytics to
1318
+ # perform logging.
1319
+ # @return [String]
1320
+ #
1321
+ # @!attribute [rw] level
1322
+ # The logging level. Currently, only "ERROR" is supported.
1323
+ # @return [String]
1324
+ #
1325
+ # @!attribute [rw] enabled
1326
+ # If true, logging is enabled for AWS IoT Analytics.
1327
+ # @return [Boolean]
1328
+ #
1329
+ class LoggingOptions < Struct.new(
1330
+ :role_arn,
1331
+ :level,
1332
+ :enabled)
1333
+ include Aws::Structure
1334
+ end
1335
+
1336
+ # An activity that computes an arithmetic expression using the
1337
+ # message's attributes.
1338
+ #
1339
+ # @note When making an API call, you may pass MathActivity
1340
+ # data as a hash:
1341
+ #
1342
+ # {
1343
+ # name: "ActivityName", # required
1344
+ # attribute: "AttributeName", # required
1345
+ # math: "MathExpression", # required
1346
+ # next: "ActivityName",
1347
+ # }
1348
+ #
1349
+ # @!attribute [rw] name
1350
+ # The name of the 'math' activity.
1351
+ # @return [String]
1352
+ #
1353
+ # @!attribute [rw] attribute
1354
+ # The name of the attribute that will contain the result of the math
1355
+ # operation.
1356
+ # @return [String]
1357
+ #
1358
+ # @!attribute [rw] math
1359
+ # An expression that uses one or more existing attributes and must
1360
+ # return an integer value.
1361
+ # @return [String]
1362
+ #
1363
+ # @!attribute [rw] next
1364
+ # The next activity in the pipeline.
1365
+ # @return [String]
1366
+ #
1367
+ class MathActivity < Struct.new(
1368
+ :name,
1369
+ :attribute,
1370
+ :math,
1371
+ :next)
1372
+ include Aws::Structure
1373
+ end
1374
+
1375
+ # Information about a message.
1376
+ #
1377
+ # @note When making an API call, you may pass Message
1378
+ # data as a hash:
1379
+ #
1380
+ # {
1381
+ # message_id: "MessageId", # required
1382
+ # payload: "data", # required
1383
+ # }
1384
+ #
1385
+ # @!attribute [rw] message_id
1386
+ # The ID you wish to assign to the message.
1387
+ # @return [String]
1388
+ #
1389
+ # @!attribute [rw] payload
1390
+ # The payload of the message.
1391
+ # @return [String]
1392
+ #
1393
+ class Message < Struct.new(
1394
+ :message_id,
1395
+ :payload)
1396
+ include Aws::Structure
1397
+ end
1398
+
1399
+ # Contains information about a pipeline.
1400
+ #
1401
+ # @!attribute [rw] name
1402
+ # The name of the pipeline.
1403
+ # @return [String]
1404
+ #
1405
+ # @!attribute [rw] arn
1406
+ # The ARN of the pipeline.
1407
+ # @return [String]
1408
+ #
1409
+ # @!attribute [rw] activities
1410
+ # The activities that perform transformations on the messages.
1411
+ # @return [Array<Types::PipelineActivity>]
1412
+ #
1413
+ # @!attribute [rw] reprocessing_summaries
1414
+ # A summary of information about the pipeline reprocessing.
1415
+ # @return [Array<Types::ReprocessingSummary>]
1416
+ #
1417
+ # @!attribute [rw] creation_time
1418
+ # When the pipeline was created.
1419
+ # @return [Time]
1420
+ #
1421
+ # @!attribute [rw] last_update_time
1422
+ # The last time the pipeline was updated.
1423
+ # @return [Time]
1424
+ #
1425
+ class Pipeline < Struct.new(
1426
+ :name,
1427
+ :arn,
1428
+ :activities,
1429
+ :reprocessing_summaries,
1430
+ :creation_time,
1431
+ :last_update_time)
1432
+ include Aws::Structure
1433
+ end
1434
+
1435
+ # An activity that performs a transformation on a message.
1436
+ #
1437
+ # @note When making an API call, you may pass PipelineActivity
1438
+ # data as a hash:
1439
+ #
1440
+ # {
1441
+ # channel: {
1442
+ # name: "ActivityName", # required
1443
+ # channel_name: "ChannelName", # required
1444
+ # next: "ActivityName",
1445
+ # },
1446
+ # lambda: {
1447
+ # name: "ActivityName", # required
1448
+ # lambda_name: "LambdaName", # required
1449
+ # batch_size: 1, # required
1450
+ # next: "ActivityName",
1451
+ # },
1452
+ # datastore: {
1453
+ # name: "ActivityName", # required
1454
+ # datastore_name: "DatastoreName", # required
1455
+ # },
1456
+ # add_attributes: {
1457
+ # name: "ActivityName", # required
1458
+ # attributes: { # required
1459
+ # "AttributeName" => "AttributeName",
1460
+ # },
1461
+ # next: "ActivityName",
1462
+ # },
1463
+ # remove_attributes: {
1464
+ # name: "ActivityName", # required
1465
+ # attributes: ["AttributeName"], # required
1466
+ # next: "ActivityName",
1467
+ # },
1468
+ # select_attributes: {
1469
+ # name: "ActivityName", # required
1470
+ # attributes: ["AttributeName"], # required
1471
+ # next: "ActivityName",
1472
+ # },
1473
+ # filter: {
1474
+ # name: "ActivityName", # required
1475
+ # filter: "FilterExpression", # required
1476
+ # next: "ActivityName",
1477
+ # },
1478
+ # math: {
1479
+ # name: "ActivityName", # required
1480
+ # attribute: "AttributeName", # required
1481
+ # math: "MathExpression", # required
1482
+ # next: "ActivityName",
1483
+ # },
1484
+ # device_registry_enrich: {
1485
+ # name: "ActivityName", # required
1486
+ # attribute: "AttributeName", # required
1487
+ # thing_name: "AttributeName", # required
1488
+ # role_arn: "RoleArn", # required
1489
+ # next: "ActivityName",
1490
+ # },
1491
+ # device_shadow_enrich: {
1492
+ # name: "ActivityName", # required
1493
+ # attribute: "AttributeName", # required
1494
+ # thing_name: "AttributeName", # required
1495
+ # role_arn: "RoleArn", # required
1496
+ # next: "ActivityName",
1497
+ # },
1498
+ # }
1499
+ #
1500
+ # @!attribute [rw] channel
1501
+ # Determines the source of the messages to be processed.
1502
+ # @return [Types::ChannelActivity]
1503
+ #
1504
+ # @!attribute [rw] lambda
1505
+ # Runs a Lambda function to modify the message.
1506
+ # @return [Types::LambdaActivity]
1507
+ #
1508
+ # @!attribute [rw] datastore
1509
+ # Specifies where to store the processed message data.
1510
+ # @return [Types::DatastoreActivity]
1511
+ #
1512
+ # @!attribute [rw] add_attributes
1513
+ # Adds other attributes based on existing attributes in the message.
1514
+ # @return [Types::AddAttributesActivity]
1515
+ #
1516
+ # @!attribute [rw] remove_attributes
1517
+ # Removes attributes from a message.
1518
+ # @return [Types::RemoveAttributesActivity]
1519
+ #
1520
+ # @!attribute [rw] select_attributes
1521
+ # Creates a new message using only the specified attributes from the
1522
+ # original message.
1523
+ # @return [Types::SelectAttributesActivity]
1524
+ #
1525
+ # @!attribute [rw] filter
1526
+ # Filters a message based on its attributes.
1527
+ # @return [Types::FilterActivity]
1528
+ #
1529
+ # @!attribute [rw] math
1530
+ # Computes an arithmetic expression using the message's attributes
1531
+ # and adds it to the message.
1532
+ # @return [Types::MathActivity]
1533
+ #
1534
+ # @!attribute [rw] device_registry_enrich
1535
+ # Adds data from the AWS IoT device registry to your message.
1536
+ # @return [Types::DeviceRegistryEnrichActivity]
1537
+ #
1538
+ # @!attribute [rw] device_shadow_enrich
1539
+ # Adds information from the AWS IoT Device Shadows service to a
1540
+ # message.
1541
+ # @return [Types::DeviceShadowEnrichActivity]
1542
+ #
1543
+ class PipelineActivity < Struct.new(
1544
+ :channel,
1545
+ :lambda,
1546
+ :datastore,
1547
+ :add_attributes,
1548
+ :remove_attributes,
1549
+ :select_attributes,
1550
+ :filter,
1551
+ :math,
1552
+ :device_registry_enrich,
1553
+ :device_shadow_enrich)
1554
+ include Aws::Structure
1555
+ end
1556
+
1557
+ # A summary of information about a pipeline.
1558
+ #
1559
+ # @!attribute [rw] pipeline_name
1560
+ # The name of the pipeline.
1561
+ # @return [String]
1562
+ #
1563
+ # @!attribute [rw] reprocessing_summaries
1564
+ # A summary of information about the pipeline reprocessing.
1565
+ # @return [Array<Types::ReprocessingSummary>]
1566
+ #
1567
+ # @!attribute [rw] creation_time
1568
+ # When the pipeline was created.
1569
+ # @return [Time]
1570
+ #
1571
+ # @!attribute [rw] last_update_time
1572
+ # When the pipeline was last updated.
1573
+ # @return [Time]
1574
+ #
1575
+ class PipelineSummary < Struct.new(
1576
+ :pipeline_name,
1577
+ :reprocessing_summaries,
1578
+ :creation_time,
1579
+ :last_update_time)
1580
+ include Aws::Structure
1581
+ end
1582
+
1583
+ # @note When making an API call, you may pass PutLoggingOptionsRequest
1584
+ # data as a hash:
1585
+ #
1586
+ # {
1587
+ # logging_options: { # required
1588
+ # role_arn: "RoleArn", # required
1589
+ # level: "ERROR", # required, accepts ERROR
1590
+ # enabled: false, # required
1591
+ # },
1592
+ # }
1593
+ #
1594
+ # @!attribute [rw] logging_options
1595
+ # The new values of the AWS IoT Analytics logging options.
1596
+ # @return [Types::LoggingOptions]
1597
+ #
1598
+ class PutLoggingOptionsRequest < Struct.new(
1599
+ :logging_options)
1600
+ include Aws::Structure
1601
+ end
1602
+
1603
+ # An activity that removes attributes from a message.
1604
+ #
1605
+ # @note When making an API call, you may pass RemoveAttributesActivity
1606
+ # data as a hash:
1607
+ #
1608
+ # {
1609
+ # name: "ActivityName", # required
1610
+ # attributes: ["AttributeName"], # required
1611
+ # next: "ActivityName",
1612
+ # }
1613
+ #
1614
+ # @!attribute [rw] name
1615
+ # The name of the 'removeAttributes' activity.
1616
+ # @return [String]
1617
+ #
1618
+ # @!attribute [rw] attributes
1619
+ # A list of 1-50 attributes to remove from the message.
1620
+ # @return [Array<String>]
1621
+ #
1622
+ # @!attribute [rw] next
1623
+ # The next activity in the pipeline.
1624
+ # @return [String]
1625
+ #
1626
+ class RemoveAttributesActivity < Struct.new(
1627
+ :name,
1628
+ :attributes,
1629
+ :next)
1630
+ include Aws::Structure
1631
+ end
1632
+
1633
+ # Information about pipeline reprocessing.
1634
+ #
1635
+ # @!attribute [rw] id
1636
+ # The 'reprocessingId' returned by "StartPipelineReprocessing".
1637
+ # @return [String]
1638
+ #
1639
+ # @!attribute [rw] status
1640
+ # The status of the pipeline reprocessing.
1641
+ # @return [String]
1642
+ #
1643
+ # @!attribute [rw] creation_time
1644
+ # The time the pipeline reprocessing was created.
1645
+ # @return [Time]
1646
+ #
1647
+ class ReprocessingSummary < Struct.new(
1648
+ :id,
1649
+ :status,
1650
+ :creation_time)
1651
+ include Aws::Structure
1652
+ end
1653
+
1654
+ # How long, in days, message data is kept.
1655
+ #
1656
+ # @note When making an API call, you may pass RetentionPeriod
1657
+ # data as a hash:
1658
+ #
1659
+ # {
1660
+ # unlimited: false,
1661
+ # number_of_days: 1,
1662
+ # }
1663
+ #
1664
+ # @!attribute [rw] unlimited
1665
+ # If true, message data is kept indefinitely.
1666
+ # @return [Boolean]
1667
+ #
1668
+ # @!attribute [rw] number_of_days
1669
+ # The number of days that message data is kept. The "unlimited"
1670
+ # parameter must be false.
1671
+ # @return [Integer]
1672
+ #
1673
+ class RetentionPeriod < Struct.new(
1674
+ :unlimited,
1675
+ :number_of_days)
1676
+ include Aws::Structure
1677
+ end
1678
+
1679
+ # @note When making an API call, you may pass RunPipelineActivityRequest
1680
+ # data as a hash:
1681
+ #
1682
+ # {
1683
+ # pipeline_activity: { # required
1684
+ # channel: {
1685
+ # name: "ActivityName", # required
1686
+ # channel_name: "ChannelName", # required
1687
+ # next: "ActivityName",
1688
+ # },
1689
+ # lambda: {
1690
+ # name: "ActivityName", # required
1691
+ # lambda_name: "LambdaName", # required
1692
+ # batch_size: 1, # required
1693
+ # next: "ActivityName",
1694
+ # },
1695
+ # datastore: {
1696
+ # name: "ActivityName", # required
1697
+ # datastore_name: "DatastoreName", # required
1698
+ # },
1699
+ # add_attributes: {
1700
+ # name: "ActivityName", # required
1701
+ # attributes: { # required
1702
+ # "AttributeName" => "AttributeName",
1703
+ # },
1704
+ # next: "ActivityName",
1705
+ # },
1706
+ # remove_attributes: {
1707
+ # name: "ActivityName", # required
1708
+ # attributes: ["AttributeName"], # required
1709
+ # next: "ActivityName",
1710
+ # },
1711
+ # select_attributes: {
1712
+ # name: "ActivityName", # required
1713
+ # attributes: ["AttributeName"], # required
1714
+ # next: "ActivityName",
1715
+ # },
1716
+ # filter: {
1717
+ # name: "ActivityName", # required
1718
+ # filter: "FilterExpression", # required
1719
+ # next: "ActivityName",
1720
+ # },
1721
+ # math: {
1722
+ # name: "ActivityName", # required
1723
+ # attribute: "AttributeName", # required
1724
+ # math: "MathExpression", # required
1725
+ # next: "ActivityName",
1726
+ # },
1727
+ # device_registry_enrich: {
1728
+ # name: "ActivityName", # required
1729
+ # attribute: "AttributeName", # required
1730
+ # thing_name: "AttributeName", # required
1731
+ # role_arn: "RoleArn", # required
1732
+ # next: "ActivityName",
1733
+ # },
1734
+ # device_shadow_enrich: {
1735
+ # name: "ActivityName", # required
1736
+ # attribute: "AttributeName", # required
1737
+ # thing_name: "AttributeName", # required
1738
+ # role_arn: "RoleArn", # required
1739
+ # next: "ActivityName",
1740
+ # },
1741
+ # },
1742
+ # payloads: ["data"], # required
1743
+ # }
1744
+ #
1745
+ # @!attribute [rw] pipeline_activity
1746
+ # The pipeline activity that is run. This must not be a 'channel'
1747
+ # activity or a 'datastore' activity because these activities are
1748
+ # used in a pipeline only to load the original message and to store
1749
+ # the (possibly) transformed message. If a 'lambda' activity is
1750
+ # specified, only short-running Lambda functions (those with a timeout
1751
+ # of less than 30 seconds or less) can be used.
1752
+ # @return [Types::PipelineActivity]
1753
+ #
1754
+ # @!attribute [rw] payloads
1755
+ # The sample message payloads on which the pipeline activity is run.
1756
+ # @return [Array<String>]
1757
+ #
1758
+ class RunPipelineActivityRequest < Struct.new(
1759
+ :pipeline_activity,
1760
+ :payloads)
1761
+ include Aws::Structure
1762
+ end
1763
+
1764
+ # @!attribute [rw] payloads
1765
+ # The enriched or transformed sample message payloads as
1766
+ # base64-encoded strings. (The results of running the pipeline
1767
+ # activity on each input sample message payload, encoded in base64.)
1768
+ # @return [Array<String>]
1769
+ #
1770
+ # @!attribute [rw] log_result
1771
+ # In case the pipeline activity fails, the log message that is
1772
+ # generated.
1773
+ # @return [String]
1774
+ #
1775
+ class RunPipelineActivityResponse < Struct.new(
1776
+ :payloads,
1777
+ :log_result)
1778
+ include Aws::Structure
1779
+ end
1780
+
1781
+ # @note When making an API call, you may pass SampleChannelDataRequest
1782
+ # data as a hash:
1783
+ #
1784
+ # {
1785
+ # channel_name: "ChannelName", # required
1786
+ # max_messages: 1,
1787
+ # start_time: Time.now,
1788
+ # end_time: Time.now,
1789
+ # }
1790
+ #
1791
+ # @!attribute [rw] channel_name
1792
+ # The name of the channel whose message samples are retrieved.
1793
+ # @return [String]
1794
+ #
1795
+ # @!attribute [rw] max_messages
1796
+ # The number of sample messages to be retrieved. The limit is 10, the
1797
+ # default is also 10.
1798
+ # @return [Integer]
1799
+ #
1800
+ # @!attribute [rw] start_time
1801
+ # The start of the time window from which sample messages are
1802
+ # retrieved.
1803
+ # @return [Time]
1804
+ #
1805
+ # @!attribute [rw] end_time
1806
+ # The end of the time window from which sample messages are retrieved.
1807
+ # @return [Time]
1808
+ #
1809
+ class SampleChannelDataRequest < Struct.new(
1810
+ :channel_name,
1811
+ :max_messages,
1812
+ :start_time,
1813
+ :end_time)
1814
+ include Aws::Structure
1815
+ end
1816
+
1817
+ # @!attribute [rw] payloads
1818
+ # The list of message samples. Each sample message is returned as a
1819
+ # base64-encoded string.
1820
+ # @return [Array<String>]
1821
+ #
1822
+ class SampleChannelDataResponse < Struct.new(
1823
+ :payloads)
1824
+ include Aws::Structure
1825
+ end
1826
+
1827
+ # The schedule for when to trigger an update.
1828
+ #
1829
+ # @note When making an API call, you may pass Schedule
1830
+ # data as a hash:
1831
+ #
1832
+ # {
1833
+ # expression: "ScheduleExpression",
1834
+ # }
1835
+ #
1836
+ # @!attribute [rw] expression
1837
+ # The expression that defines when to trigger an update. For more
1838
+ # information, see [ Schedule Expressions for Rules][1] in the Amazon
1839
+ # CloudWatch documentation.
1840
+ #
1841
+ #
1842
+ #
1843
+ # [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html
1844
+ # @return [String]
1845
+ #
1846
+ class Schedule < Struct.new(
1847
+ :expression)
1848
+ include Aws::Structure
1849
+ end
1850
+
1851
+ # Creates a new message using only the specified attributes from the
1852
+ # original message.
1853
+ #
1854
+ # @note When making an API call, you may pass SelectAttributesActivity
1855
+ # data as a hash:
1856
+ #
1857
+ # {
1858
+ # name: "ActivityName", # required
1859
+ # attributes: ["AttributeName"], # required
1860
+ # next: "ActivityName",
1861
+ # }
1862
+ #
1863
+ # @!attribute [rw] name
1864
+ # The name of the 'selectAttributes' activity.
1865
+ # @return [String]
1866
+ #
1867
+ # @!attribute [rw] attributes
1868
+ # A list of the attributes to select from the message.
1869
+ # @return [Array<String>]
1870
+ #
1871
+ # @!attribute [rw] next
1872
+ # The next activity in the pipeline.
1873
+ # @return [String]
1874
+ #
1875
+ class SelectAttributesActivity < Struct.new(
1876
+ :name,
1877
+ :attributes,
1878
+ :next)
1879
+ include Aws::Structure
1880
+ end
1881
+
1882
+ # The SQL query to modify the message.
1883
+ #
1884
+ # @note When making an API call, you may pass SqlQueryDatasetAction
1885
+ # data as a hash:
1886
+ #
1887
+ # {
1888
+ # sql_query: "SqlQuery", # required
1889
+ # }
1890
+ #
1891
+ # @!attribute [rw] sql_query
1892
+ # An SQL query string.
1893
+ # @return [String]
1894
+ #
1895
+ class SqlQueryDatasetAction < Struct.new(
1896
+ :sql_query)
1897
+ include Aws::Structure
1898
+ end
1899
+
1900
+ # @note When making an API call, you may pass StartPipelineReprocessingRequest
1901
+ # data as a hash:
1902
+ #
1903
+ # {
1904
+ # pipeline_name: "PipelineName", # required
1905
+ # start_time: Time.now,
1906
+ # end_time: Time.now,
1907
+ # }
1908
+ #
1909
+ # @!attribute [rw] pipeline_name
1910
+ # The name of the pipeline on which to start reprocessing.
1911
+ # @return [String]
1912
+ #
1913
+ # @!attribute [rw] start_time
1914
+ # The start time (inclusive) of raw message data that is reprocessed.
1915
+ # @return [Time]
1916
+ #
1917
+ # @!attribute [rw] end_time
1918
+ # The end time (exclusive) of raw message data that is reprocessed.
1919
+ # @return [Time]
1920
+ #
1921
+ class StartPipelineReprocessingRequest < Struct.new(
1922
+ :pipeline_name,
1923
+ :start_time,
1924
+ :end_time)
1925
+ include Aws::Structure
1926
+ end
1927
+
1928
+ # @!attribute [rw] reprocessing_id
1929
+ # The ID of the pipeline reprocessing activity that was started.
1930
+ # @return [String]
1931
+ #
1932
+ class StartPipelineReprocessingResponse < Struct.new(
1933
+ :reprocessing_id)
1934
+ include Aws::Structure
1935
+ end
1936
+
1937
+ # @note When making an API call, you may pass UpdateChannelRequest
1938
+ # data as a hash:
1939
+ #
1940
+ # {
1941
+ # channel_name: "ChannelName", # required
1942
+ # retention_period: {
1943
+ # unlimited: false,
1944
+ # number_of_days: 1,
1945
+ # },
1946
+ # }
1947
+ #
1948
+ # @!attribute [rw] channel_name
1949
+ # The name of the channel to be updated.
1950
+ # @return [String]
1951
+ #
1952
+ # @!attribute [rw] retention_period
1953
+ # How long, in days, message data is kept for the channel.
1954
+ # @return [Types::RetentionPeriod]
1955
+ #
1956
+ class UpdateChannelRequest < Struct.new(
1957
+ :channel_name,
1958
+ :retention_period)
1959
+ include Aws::Structure
1960
+ end
1961
+
1962
+ # @note When making an API call, you may pass UpdateDatasetRequest
1963
+ # data as a hash:
1964
+ #
1965
+ # {
1966
+ # dataset_name: "DatasetName", # required
1967
+ # actions: [ # required
1968
+ # {
1969
+ # action_name: "DatasetActionName",
1970
+ # query_action: {
1971
+ # sql_query: "SqlQuery", # required
1972
+ # },
1973
+ # },
1974
+ # ],
1975
+ # triggers: [
1976
+ # {
1977
+ # schedule: {
1978
+ # expression: "ScheduleExpression",
1979
+ # },
1980
+ # },
1981
+ # ],
1982
+ # }
1983
+ #
1984
+ # @!attribute [rw] dataset_name
1985
+ # The name of the data set to update.
1986
+ # @return [String]
1987
+ #
1988
+ # @!attribute [rw] actions
1989
+ # A list of "DatasetAction" objects. Only one action is supported at
1990
+ # this time.
1991
+ # @return [Array<Types::DatasetAction>]
1992
+ #
1993
+ # @!attribute [rw] triggers
1994
+ # A list of "DatasetTrigger" objects. The list can be empty or can
1995
+ # contain up to five **DataSetTrigger** objects.
1996
+ # @return [Array<Types::DatasetTrigger>]
1997
+ #
1998
+ class UpdateDatasetRequest < Struct.new(
1999
+ :dataset_name,
2000
+ :actions,
2001
+ :triggers)
2002
+ include Aws::Structure
2003
+ end
2004
+
2005
+ # @note When making an API call, you may pass UpdateDatastoreRequest
2006
+ # data as a hash:
2007
+ #
2008
+ # {
2009
+ # datastore_name: "DatastoreName", # required
2010
+ # retention_period: {
2011
+ # unlimited: false,
2012
+ # number_of_days: 1,
2013
+ # },
2014
+ # }
2015
+ #
2016
+ # @!attribute [rw] datastore_name
2017
+ # The name of the data store to be updated.
2018
+ # @return [String]
2019
+ #
2020
+ # @!attribute [rw] retention_period
2021
+ # How long, in days, message data is kept for the data store.
2022
+ # @return [Types::RetentionPeriod]
2023
+ #
2024
+ class UpdateDatastoreRequest < Struct.new(
2025
+ :datastore_name,
2026
+ :retention_period)
2027
+ include Aws::Structure
2028
+ end
2029
+
2030
+ # @note When making an API call, you may pass UpdatePipelineRequest
2031
+ # data as a hash:
2032
+ #
2033
+ # {
2034
+ # pipeline_name: "PipelineName", # required
2035
+ # pipeline_activities: [ # required
2036
+ # {
2037
+ # channel: {
2038
+ # name: "ActivityName", # required
2039
+ # channel_name: "ChannelName", # required
2040
+ # next: "ActivityName",
2041
+ # },
2042
+ # lambda: {
2043
+ # name: "ActivityName", # required
2044
+ # lambda_name: "LambdaName", # required
2045
+ # batch_size: 1, # required
2046
+ # next: "ActivityName",
2047
+ # },
2048
+ # datastore: {
2049
+ # name: "ActivityName", # required
2050
+ # datastore_name: "DatastoreName", # required
2051
+ # },
2052
+ # add_attributes: {
2053
+ # name: "ActivityName", # required
2054
+ # attributes: { # required
2055
+ # "AttributeName" => "AttributeName",
2056
+ # },
2057
+ # next: "ActivityName",
2058
+ # },
2059
+ # remove_attributes: {
2060
+ # name: "ActivityName", # required
2061
+ # attributes: ["AttributeName"], # required
2062
+ # next: "ActivityName",
2063
+ # },
2064
+ # select_attributes: {
2065
+ # name: "ActivityName", # required
2066
+ # attributes: ["AttributeName"], # required
2067
+ # next: "ActivityName",
2068
+ # },
2069
+ # filter: {
2070
+ # name: "ActivityName", # required
2071
+ # filter: "FilterExpression", # required
2072
+ # next: "ActivityName",
2073
+ # },
2074
+ # math: {
2075
+ # name: "ActivityName", # required
2076
+ # attribute: "AttributeName", # required
2077
+ # math: "MathExpression", # required
2078
+ # next: "ActivityName",
2079
+ # },
2080
+ # device_registry_enrich: {
2081
+ # name: "ActivityName", # required
2082
+ # attribute: "AttributeName", # required
2083
+ # thing_name: "AttributeName", # required
2084
+ # role_arn: "RoleArn", # required
2085
+ # next: "ActivityName",
2086
+ # },
2087
+ # device_shadow_enrich: {
2088
+ # name: "ActivityName", # required
2089
+ # attribute: "AttributeName", # required
2090
+ # thing_name: "AttributeName", # required
2091
+ # role_arn: "RoleArn", # required
2092
+ # next: "ActivityName",
2093
+ # },
2094
+ # },
2095
+ # ],
2096
+ # }
2097
+ #
2098
+ # @!attribute [rw] pipeline_name
2099
+ # The name of the pipeline to update.
2100
+ # @return [String]
2101
+ #
2102
+ # @!attribute [rw] pipeline_activities
2103
+ # A list of "PipelineActivity" objects.
2104
+ #
2105
+ # The list can be 1-25 **PipelineActivity** objects. Activities
2106
+ # perform transformations on your messages, such as removing, renaming
2107
+ # or adding message attributes; filtering messages based on attribute
2108
+ # values; invoking your Lambda functions on messages for advanced
2109
+ # processing; or performing mathematical transformations to normalize
2110
+ # device data.
2111
+ # @return [Array<Types::PipelineActivity>]
2112
+ #
2113
+ class UpdatePipelineRequest < Struct.new(
2114
+ :pipeline_name,
2115
+ :pipeline_activities)
2116
+ include Aws::Structure
2117
+ end
2118
+
2119
+ end
2120
+ end