aws-sdk-iotmanagedintegrations 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,3327 @@
1
+ # frozen_string_literal: true
2
+
3
+ # WARNING ABOUT GENERATED CODE
4
+ #
5
+ # This file is generated. See the contributing guide for more information:
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
+ #
8
+ # WARNING ABOUT GENERATED CODE
9
+
10
+ module Aws::IoTManagedIntegrations
11
+ module Types
12
+
13
+ # Structure representing one abort config criteria.
14
+ #
15
+ # @!attribute [rw] action
16
+ # The action taken by the abort configuration.
17
+ # @return [String]
18
+ #
19
+ # @!attribute [rw] failure_type
20
+ # Over-the-air (OTA) task abort criteria failure type.
21
+ # @return [String]
22
+ #
23
+ # @!attribute [rw] min_number_of_executed_things
24
+ # The minimum number of things that must receive task execution
25
+ # notifications before the task can be aborted.
26
+ # @return [Integer]
27
+ #
28
+ # @!attribute [rw] threshold_percentage
29
+ # The minimum percentage of over-the-air (OTA) task execution failures
30
+ # that must occur to initiate the last abort.
31
+ # @return [Float]
32
+ #
33
+ class AbortConfigCriteria < Struct.new(
34
+ :action,
35
+ :failure_type,
36
+ :min_number_of_executed_things,
37
+ :threshold_percentage)
38
+ SENSITIVE = []
39
+ include Aws::Structure
40
+ end
41
+
42
+ # User is not authorized.
43
+ #
44
+ # @!attribute [rw] message
45
+ # @return [String]
46
+ #
47
+ class AccessDeniedException < Struct.new(
48
+ :message)
49
+ SENSITIVE = []
50
+ include Aws::Structure
51
+ end
52
+
53
+ # Action for an Amazon Web Services capability, containing the action
54
+ # parameters for control.
55
+ #
56
+ # @!attribute [rw] name
57
+ # Describe a capability action with a name.
58
+ # @return [String]
59
+ #
60
+ # @!attribute [rw] ref
61
+ # Describe a capability action with an reference.
62
+ # @return [String]
63
+ #
64
+ # @!attribute [rw] action_trace_id
65
+ # Describe a capability action with an `actionTraceId` for a response
66
+ # command.
67
+ # @return [String]
68
+ #
69
+ # @!attribute [rw] parameters
70
+ # Describe a capability action with a capability property.
71
+ # @return [Hash,Array,String,Numeric,Boolean]
72
+ #
73
+ class CapabilityAction < Struct.new(
74
+ :name,
75
+ :ref,
76
+ :action_trace_id,
77
+ :parameters)
78
+ SENSITIVE = [:parameters]
79
+ include Aws::Structure
80
+ end
81
+
82
+ # Report of all capabilities supported by the device.
83
+ #
84
+ # @!attribute [rw] version
85
+ # The version of the capability report.
86
+ # @return [String]
87
+ #
88
+ # @!attribute [rw] node_id
89
+ # The numeric identifier of the node.
90
+ # @return [String]
91
+ #
92
+ # @!attribute [rw] endpoints
93
+ # The endpoints used in the capability report.
94
+ # @return [Array<Types::CapabilityReportEndpoint>]
95
+ #
96
+ class CapabilityReport < Struct.new(
97
+ :version,
98
+ :node_id,
99
+ :endpoints)
100
+ SENSITIVE = []
101
+ include Aws::Structure
102
+ end
103
+
104
+ # The capability used in capability report.
105
+ #
106
+ # @!attribute [rw] id
107
+ # The id of the schema version.
108
+ # @return [String]
109
+ #
110
+ # @!attribute [rw] name
111
+ # The name of the capability.
112
+ # @return [String]
113
+ #
114
+ # @!attribute [rw] version
115
+ # The version of the capability.
116
+ # @return [String]
117
+ #
118
+ # @!attribute [rw] properties
119
+ # The capability properties used in the capability report.
120
+ # @return [Array<String>]
121
+ #
122
+ # @!attribute [rw] actions
123
+ # The capability actions used in the capability report.
124
+ # @return [Array<String>]
125
+ #
126
+ # @!attribute [rw] events
127
+ # The capability events used in the capability report.
128
+ # @return [Array<String>]
129
+ #
130
+ class CapabilityReportCapability < Struct.new(
131
+ :id,
132
+ :name,
133
+ :version,
134
+ :properties,
135
+ :actions,
136
+ :events)
137
+ SENSITIVE = []
138
+ include Aws::Structure
139
+ end
140
+
141
+ # The endpoint used in the capability report.
142
+ #
143
+ # @!attribute [rw] id
144
+ # The id of the endpoint used in the capability report.
145
+ # @return [String]
146
+ #
147
+ # @!attribute [rw] device_types
148
+ # The type of device.
149
+ # @return [Array<String>]
150
+ #
151
+ # @!attribute [rw] capabilities
152
+ # The capabilities used in the capability report.
153
+ # @return [Array<Types::CapabilityReportCapability>]
154
+ #
155
+ class CapabilityReportEndpoint < Struct.new(
156
+ :id,
157
+ :device_types,
158
+ :capabilities)
159
+ SENSITIVE = []
160
+ include Aws::Structure
161
+ end
162
+
163
+ # The command capabilities added for the managed thing
164
+ #
165
+ # @!attribute [rw] id
166
+ # Describe the capability with an id.
167
+ # @return [String]
168
+ #
169
+ # @!attribute [rw] name
170
+ # Describe the capability with an name.
171
+ # @return [String]
172
+ #
173
+ # @!attribute [rw] version
174
+ # Describe the capability with a version.
175
+ # @return [String]
176
+ #
177
+ # @!attribute [rw] actions
178
+ # Describe the command capability with the actions it supports.
179
+ # @return [Array<Types::CapabilityAction>]
180
+ #
181
+ class CommandCapability < Struct.new(
182
+ :id,
183
+ :name,
184
+ :version,
185
+ :actions)
186
+ SENSITIVE = []
187
+ include Aws::Structure
188
+ end
189
+
190
+ # The endpoint for a managed thing when sending a command.
191
+ #
192
+ # @!attribute [rw] endpoint_id
193
+ # The id of the endpoint for a managed thing.
194
+ # @return [String]
195
+ #
196
+ # @!attribute [rw] capabilities
197
+ # Describe the endpoint with an id, a name, and the relevant
198
+ # capabilities for sending commands.
199
+ # @return [Array<Types::CommandCapability>]
200
+ #
201
+ class CommandEndpoint < Struct.new(
202
+ :endpoint_id,
203
+ :capabilities)
204
+ SENSITIVE = []
205
+ include Aws::Structure
206
+ end
207
+
208
+ # Provides the default encryption configuration error update details.
209
+ #
210
+ # @!attribute [rw] code
211
+ # The error code returned when the default encryption configuration
212
+ # update fails.
213
+ # @return [String]
214
+ #
215
+ # @!attribute [rw] message
216
+ # The error message returned when the default encryption configuration
217
+ # update fails.
218
+ # @return [String]
219
+ #
220
+ class ConfigurationError < Struct.new(
221
+ :code,
222
+ :message)
223
+ SENSITIVE = []
224
+ include Aws::Structure
225
+ end
226
+
227
+ # Provides the status of the default encryption configuration for an
228
+ # Amazon Web Services account.
229
+ #
230
+ # @!attribute [rw] error
231
+ # The error details describing a failed default encryption
232
+ # configuration update.
233
+ # @return [Types::ConfigurationError]
234
+ #
235
+ # @!attribute [rw] state
236
+ # The status state describing the default encryption configuration
237
+ # update.
238
+ # @return [String]
239
+ #
240
+ class ConfigurationStatus < Struct.new(
241
+ :error,
242
+ :state)
243
+ SENSITIVE = []
244
+ include Aws::Structure
245
+ end
246
+
247
+ # There is a conflict with the request.
248
+ #
249
+ # @!attribute [rw] message
250
+ # @return [String]
251
+ #
252
+ class ConflictException < Struct.new(
253
+ :message)
254
+ SENSITIVE = []
255
+ include Aws::Structure
256
+ end
257
+
258
+ # @!attribute [rw] name
259
+ # The name of the credential locker.
260
+ # @return [String]
261
+ #
262
+ # @!attribute [rw] client_token
263
+ # An idempotency token. If you retry a request that completed
264
+ # successfully initially using the same client token and parameters,
265
+ # then the retry attempt will succeed without performing any further
266
+ # actions.
267
+ #
268
+ # **A suitable default value is auto-generated.** You should normally
269
+ # not need to pass this option.
270
+ # @return [String]
271
+ #
272
+ # @!attribute [rw] tags
273
+ # A set of key/value pairs that are used to manage the credential
274
+ # locker.
275
+ # @return [Hash<String,String>]
276
+ #
277
+ class CreateCredentialLockerRequest < Struct.new(
278
+ :name,
279
+ :client_token,
280
+ :tags)
281
+ SENSITIVE = [:name, :tags]
282
+ include Aws::Structure
283
+ end
284
+
285
+ # @!attribute [rw] id
286
+ # The identifier of the credential locker creation request.
287
+ # @return [String]
288
+ #
289
+ # @!attribute [rw] arn
290
+ # The Amazon Resource Name (ARN) of the credential locker.
291
+ # @return [String]
292
+ #
293
+ # @!attribute [rw] created_at
294
+ # The timestamp value of when the credential locker request occurred.
295
+ # @return [Time]
296
+ #
297
+ class CreateCredentialLockerResponse < Struct.new(
298
+ :id,
299
+ :arn,
300
+ :created_at)
301
+ SENSITIVE = []
302
+ include Aws::Structure
303
+ end
304
+
305
+ # @!attribute [rw] delivery_destination_arn
306
+ # The Amazon Resource Name (ARN) of the customer-managed destination.
307
+ # @return [String]
308
+ #
309
+ # @!attribute [rw] delivery_destination_type
310
+ # The destination type for the customer-managed destination.
311
+ # @return [String]
312
+ #
313
+ # @!attribute [rw] name
314
+ # The name of the customer-managed destination.
315
+ # @return [String]
316
+ #
317
+ # @!attribute [rw] role_arn
318
+ # The Amazon Resource Name (ARN) of the delivery destination role.
319
+ # @return [String]
320
+ #
321
+ # @!attribute [rw] client_token
322
+ # An idempotency token. If you retry a request that completed
323
+ # successfully initially using the same client token and parameters,
324
+ # then the retry attempt will succeed without performing any further
325
+ # actions.
326
+ #
327
+ # **A suitable default value is auto-generated.** You should normally
328
+ # not need to pass this option.
329
+ # @return [String]
330
+ #
331
+ # @!attribute [rw] description
332
+ # The description of the customer-managed destination.
333
+ # @return [String]
334
+ #
335
+ # @!attribute [rw] tags
336
+ # A set of key/value pairs that are used to manage the destination.
337
+ # @return [Hash<String,String>]
338
+ #
339
+ class CreateDestinationRequest < Struct.new(
340
+ :delivery_destination_arn,
341
+ :delivery_destination_type,
342
+ :name,
343
+ :role_arn,
344
+ :client_token,
345
+ :description,
346
+ :tags)
347
+ SENSITIVE = [:tags]
348
+ include Aws::Structure
349
+ end
350
+
351
+ # @!attribute [rw] name
352
+ # The name of the customer-managed destination.
353
+ # @return [String]
354
+ #
355
+ class CreateDestinationResponse < Struct.new(
356
+ :name)
357
+ SENSITIVE = []
358
+ include Aws::Structure
359
+ end
360
+
361
+ # @!attribute [rw] resource_type
362
+ # The type of resource for the event log configuration.
363
+ # @return [String]
364
+ #
365
+ # @!attribute [rw] resource_id
366
+ # The identifier of the resource for the event log configuration.
367
+ # @return [String]
368
+ #
369
+ # @!attribute [rw] event_log_level
370
+ # The logging level for the event log configuration.
371
+ # @return [String]
372
+ #
373
+ # @!attribute [rw] client_token
374
+ # An idempotency token. If you retry a request that completed
375
+ # successfully initially using the same client token and parameters,
376
+ # then the retry attempt will succeed without performing any further
377
+ # actions.
378
+ #
379
+ # **A suitable default value is auto-generated.** You should normally
380
+ # not need to pass this option.
381
+ # @return [String]
382
+ #
383
+ class CreateEventLogConfigurationRequest < Struct.new(
384
+ :resource_type,
385
+ :resource_id,
386
+ :event_log_level,
387
+ :client_token)
388
+ SENSITIVE = []
389
+ include Aws::Structure
390
+ end
391
+
392
+ # @!attribute [rw] id
393
+ # The identifier of the event log configuration request.
394
+ # @return [String]
395
+ #
396
+ class CreateEventLogConfigurationResponse < Struct.new(
397
+ :id)
398
+ SENSITIVE = []
399
+ include Aws::Structure
400
+ end
401
+
402
+ # @!attribute [rw] role
403
+ # The type of device used. This will be the hub controller, cloud
404
+ # device, or AWS IoT device.
405
+ # @return [String]
406
+ #
407
+ # @!attribute [rw] owner
408
+ # Owner of the device, usually an indication of whom the device
409
+ # belongs to. This value should not contain personal identifiable
410
+ # information.
411
+ # @return [String]
412
+ #
413
+ # @!attribute [rw] credential_locker_id
414
+ # The identifier of the credential for the managed thing.
415
+ # @return [String]
416
+ #
417
+ # @!attribute [rw] authentication_material
418
+ # The authentication material defining the device connectivity setup
419
+ # requests. The authentication materials used are the device bar code.
420
+ # @return [String]
421
+ #
422
+ # @!attribute [rw] authentication_material_type
423
+ # The type of authentication material used for device connectivity
424
+ # setup requests.
425
+ # @return [String]
426
+ #
427
+ # @!attribute [rw] serial_number
428
+ # The serial number of the device.
429
+ # @return [String]
430
+ #
431
+ # @!attribute [rw] brand
432
+ # The brand of the device.
433
+ # @return [String]
434
+ #
435
+ # @!attribute [rw] model
436
+ # The model of the device.
437
+ # @return [String]
438
+ #
439
+ # @!attribute [rw] name
440
+ # The name of the managed thing representing the physical device.
441
+ # @return [String]
442
+ #
443
+ # @!attribute [rw] capability_report
444
+ # A report of the capabilities for the managed thing.
445
+ # @return [Types::CapabilityReport]
446
+ #
447
+ # @!attribute [rw] capabilities
448
+ # The capabilities of the device such as light bulb.
449
+ # @return [String]
450
+ #
451
+ # @!attribute [rw] client_token
452
+ # An idempotency token. If you retry a request that completed
453
+ # successfully initially using the same client token and parameters,
454
+ # then the retry attempt will succeed without performing any further
455
+ # actions.
456
+ #
457
+ # **A suitable default value is auto-generated.** You should normally
458
+ # not need to pass this option.
459
+ # @return [String]
460
+ #
461
+ # @!attribute [rw] classification
462
+ # The classification of the managed thing such as light bulb or
463
+ # thermostat.
464
+ # @return [String]
465
+ #
466
+ # @!attribute [rw] tags
467
+ # A set of key/value pairs that are used to manage the managed thing.
468
+ # @return [Hash<String,String>]
469
+ #
470
+ # @!attribute [rw] meta_data
471
+ # The metadata for the managed thing.
472
+ # @return [Hash<String,String>]
473
+ #
474
+ class CreateManagedThingRequest < Struct.new(
475
+ :role,
476
+ :owner,
477
+ :credential_locker_id,
478
+ :authentication_material,
479
+ :authentication_material_type,
480
+ :serial_number,
481
+ :brand,
482
+ :model,
483
+ :name,
484
+ :capability_report,
485
+ :capabilities,
486
+ :client_token,
487
+ :classification,
488
+ :tags,
489
+ :meta_data)
490
+ SENSITIVE = [:owner, :authentication_material, :serial_number, :brand, :model, :classification, :tags]
491
+ include Aws::Structure
492
+ end
493
+
494
+ # @!attribute [rw] id
495
+ # The id of the managed thing.
496
+ # @return [String]
497
+ #
498
+ # @!attribute [rw] arn
499
+ # The Amazon Resource Name (ARN) of the managed thing.
500
+ # @return [String]
501
+ #
502
+ # @!attribute [rw] created_at
503
+ # The timestamp value of when the device creation request occurred.
504
+ # @return [Time]
505
+ #
506
+ class CreateManagedThingResponse < Struct.new(
507
+ :id,
508
+ :arn,
509
+ :created_at)
510
+ SENSITIVE = []
511
+ include Aws::Structure
512
+ end
513
+
514
+ # @!attribute [rw] event_type
515
+ # The type of event triggering a device notification to the
516
+ # customer-managed destination.
517
+ # @return [String]
518
+ #
519
+ # @!attribute [rw] destination_name
520
+ # The name of the destination for the notification configuration.
521
+ # @return [String]
522
+ #
523
+ # @!attribute [rw] client_token
524
+ # An idempotency token. If you retry a request that completed
525
+ # successfully initially using the same client token and parameters,
526
+ # then the retry attempt will succeed without performing any further
527
+ # actions.
528
+ #
529
+ # **A suitable default value is auto-generated.** You should normally
530
+ # not need to pass this option.
531
+ # @return [String]
532
+ #
533
+ # @!attribute [rw] tags
534
+ # A set of key/value pairs that are used to manage the notification
535
+ # configuration.
536
+ # @return [Hash<String,String>]
537
+ #
538
+ class CreateNotificationConfigurationRequest < Struct.new(
539
+ :event_type,
540
+ :destination_name,
541
+ :client_token,
542
+ :tags)
543
+ SENSITIVE = [:tags]
544
+ include Aws::Structure
545
+ end
546
+
547
+ # @!attribute [rw] event_type
548
+ # The type of event triggering a device notification to the
549
+ # customer-managed destination.
550
+ # @return [String]
551
+ #
552
+ class CreateNotificationConfigurationResponse < Struct.new(
553
+ :event_type)
554
+ SENSITIVE = []
555
+ include Aws::Structure
556
+ end
557
+
558
+ # @!attribute [rw] description
559
+ # A description of the over-the-air (OTA) task configuration.
560
+ # @return [String]
561
+ #
562
+ # @!attribute [rw] name
563
+ # The name of the over-the-air (OTA) task.
564
+ # @return [String]
565
+ #
566
+ # @!attribute [rw] push_config
567
+ # Describes the type of configuration used for the over-the-air (OTA)
568
+ # task.
569
+ # @return [Types::PushConfig]
570
+ #
571
+ # @!attribute [rw] client_token
572
+ # An idempotency token. If you retry a request that completed
573
+ # successfully initially using the same client token and parameters,
574
+ # then the retry attempt will succeed without performing any further
575
+ # actions.
576
+ #
577
+ # **A suitable default value is auto-generated.** You should normally
578
+ # not need to pass this option.
579
+ # @return [String]
580
+ #
581
+ class CreateOtaTaskConfigurationRequest < Struct.new(
582
+ :description,
583
+ :name,
584
+ :push_config,
585
+ :client_token)
586
+ SENSITIVE = [:name]
587
+ include Aws::Structure
588
+ end
589
+
590
+ # @!attribute [rw] task_configuration_id
591
+ # The identifier of the over-the-air (OTA) task configuration.
592
+ # @return [String]
593
+ #
594
+ class CreateOtaTaskConfigurationResponse < Struct.new(
595
+ :task_configuration_id)
596
+ SENSITIVE = []
597
+ include Aws::Structure
598
+ end
599
+
600
+ # @!attribute [rw] description
601
+ # The description of the over-the-air (OTA) task.
602
+ # @return [String]
603
+ #
604
+ # @!attribute [rw] s3_url
605
+ # The URL to the Amazon S3 bucket where the over-the-air (OTA) task is
606
+ # stored.
607
+ # @return [String]
608
+ #
609
+ # @!attribute [rw] protocol
610
+ # The connection protocol the over-the-air (OTA) task uses to update
611
+ # the device.
612
+ # @return [String]
613
+ #
614
+ # @!attribute [rw] target
615
+ # The device targeted for the over-the-air (OTA) task.
616
+ # @return [Array<String>]
617
+ #
618
+ # @!attribute [rw] task_configuration_id
619
+ # The identifier for the over-the-air (OTA) task configuration.
620
+ # @return [String]
621
+ #
622
+ # @!attribute [rw] ota_mechanism
623
+ # The deployment mechanism for the over-the-air (OTA) task.
624
+ # @return [String]
625
+ #
626
+ # @!attribute [rw] ota_type
627
+ # The frequency type for the over-the-air (OTA) task.
628
+ # @return [String]
629
+ #
630
+ # @!attribute [rw] ota_target_query_string
631
+ # The query string to add things to the thing group.
632
+ # @return [String]
633
+ #
634
+ # @!attribute [rw] client_token
635
+ # An idempotency token. If you retry a request that completed
636
+ # successfully initially using the same client token and parameters,
637
+ # then the retry attempt will succeed without performing any further
638
+ # actions.
639
+ #
640
+ # **A suitable default value is auto-generated.** You should normally
641
+ # not need to pass this option.
642
+ # @return [String]
643
+ #
644
+ # @!attribute [rw] ota_scheduling_config
645
+ # Over-the-air (OTA) task scheduling config.
646
+ # @return [Types::OtaTaskSchedulingConfig]
647
+ #
648
+ # @!attribute [rw] ota_task_execution_retry_config
649
+ # Over-the-air (OTA) task retry config.
650
+ # @return [Types::OtaTaskExecutionRetryConfig]
651
+ #
652
+ # @!attribute [rw] tags
653
+ # A set of key/value pairs that are used to manage the over-the-air
654
+ # (OTA) task.
655
+ # @return [Hash<String,String>]
656
+ #
657
+ class CreateOtaTaskRequest < Struct.new(
658
+ :description,
659
+ :s3_url,
660
+ :protocol,
661
+ :target,
662
+ :task_configuration_id,
663
+ :ota_mechanism,
664
+ :ota_type,
665
+ :ota_target_query_string,
666
+ :client_token,
667
+ :ota_scheduling_config,
668
+ :ota_task_execution_retry_config,
669
+ :tags)
670
+ SENSITIVE = [:tags]
671
+ include Aws::Structure
672
+ end
673
+
674
+ # @!attribute [rw] task_id
675
+ # The identifier of the over-the-air (OTA) task.
676
+ # @return [String]
677
+ #
678
+ # @!attribute [rw] task_arn
679
+ # The Amazon Resource Name (ARN) of the over-the-air (OTA) task.
680
+ # @return [String]
681
+ #
682
+ # @!attribute [rw] description
683
+ # A description of the over-the-air (OTA) task.
684
+ # @return [String]
685
+ #
686
+ class CreateOtaTaskResponse < Struct.new(
687
+ :task_id,
688
+ :task_arn,
689
+ :description)
690
+ SENSITIVE = []
691
+ include Aws::Structure
692
+ end
693
+
694
+ # @!attribute [rw] provisioning_type
695
+ # The type of provisioning workflow the device uses for onboarding to
696
+ # IoT managed integrations.
697
+ # @return [String]
698
+ #
699
+ # @!attribute [rw] ca_certificate
700
+ # The id of the certificate authority (CA) certificate.
701
+ # @return [String]
702
+ #
703
+ # @!attribute [rw] name
704
+ # The name of the provisioning template.
705
+ # @return [String]
706
+ #
707
+ # @!attribute [rw] client_token
708
+ # An idempotency token. If you retry a request that completed
709
+ # successfully initially using the same client token and parameters,
710
+ # then the retry attempt will succeed without performing any further
711
+ # actions.
712
+ #
713
+ # **A suitable default value is auto-generated.** You should normally
714
+ # not need to pass this option.
715
+ # @return [String]
716
+ #
717
+ # @!attribute [rw] tags
718
+ # A set of key/value pairs that are used to manage the provisioning
719
+ # profile.
720
+ # @return [Hash<String,String>]
721
+ #
722
+ class CreateProvisioningProfileRequest < Struct.new(
723
+ :provisioning_type,
724
+ :ca_certificate,
725
+ :name,
726
+ :client_token,
727
+ :tags)
728
+ SENSITIVE = [:ca_certificate, :tags]
729
+ include Aws::Structure
730
+ end
731
+
732
+ # @!attribute [rw] arn
733
+ # The Amazon Resource Name (ARN) of the provisioning template used in
734
+ # the provisioning profile.
735
+ # @return [String]
736
+ #
737
+ # @!attribute [rw] name
738
+ # The name of the provisioning template.
739
+ # @return [String]
740
+ #
741
+ # @!attribute [rw] provisioning_type
742
+ # The type of provisioning workflow the device uses for onboarding to
743
+ # IoT managed integrations.
744
+ # @return [String]
745
+ #
746
+ # @!attribute [rw] id
747
+ # The identifier of the provisioning profile.
748
+ # @return [String]
749
+ #
750
+ # @!attribute [rw] claim_certificate
751
+ # The id of the claim certificate.
752
+ # @return [String]
753
+ #
754
+ # @!attribute [rw] claim_certificate_private_key
755
+ # The private key of the claim certificate. This is stored securely on
756
+ # the device for validating the connection endpoint with IoT managed
757
+ # integrations using the public key.
758
+ # @return [String]
759
+ #
760
+ class CreateProvisioningProfileResponse < Struct.new(
761
+ :arn,
762
+ :name,
763
+ :provisioning_type,
764
+ :id,
765
+ :claim_certificate,
766
+ :claim_certificate_private_key)
767
+ SENSITIVE = [:claim_certificate, :claim_certificate_private_key]
768
+ include Aws::Structure
769
+ end
770
+
771
+ # Structure describing one Credential Locker.
772
+ #
773
+ # @!attribute [rw] id
774
+ # The id of the credential locker.
775
+ # @return [String]
776
+ #
777
+ # @!attribute [rw] arn
778
+ # The Amazon Resource Name (ARN) of the credential locker.
779
+ # @return [String]
780
+ #
781
+ # @!attribute [rw] name
782
+ # The name of the credential locker.
783
+ # @return [String]
784
+ #
785
+ # @!attribute [rw] created_at
786
+ # The timestampe value of when the credential locker was created at.
787
+ # @return [Time]
788
+ #
789
+ class CredentialLockerSummary < Struct.new(
790
+ :id,
791
+ :arn,
792
+ :name,
793
+ :created_at)
794
+ SENSITIVE = [:name]
795
+ include Aws::Structure
796
+ end
797
+
798
+ # @!attribute [rw] identifier
799
+ # The identifier of the credential locker.
800
+ # @return [String]
801
+ #
802
+ class DeleteCredentialLockerRequest < Struct.new(
803
+ :identifier)
804
+ SENSITIVE = []
805
+ include Aws::Structure
806
+ end
807
+
808
+ # @!attribute [rw] name
809
+ # The id of the customer-managed destination.
810
+ # @return [String]
811
+ #
812
+ class DeleteDestinationRequest < Struct.new(
813
+ :name)
814
+ SENSITIVE = []
815
+ include Aws::Structure
816
+ end
817
+
818
+ # @!attribute [rw] id
819
+ # The identifier of the event log configuration.
820
+ # @return [String]
821
+ #
822
+ class DeleteEventLogConfigurationRequest < Struct.new(
823
+ :id)
824
+ SENSITIVE = []
825
+ include Aws::Structure
826
+ end
827
+
828
+ # @!attribute [rw] identifier
829
+ # The id of the managed thing.
830
+ # @return [String]
831
+ #
832
+ # @!attribute [rw] force
833
+ # When set to `TRUE`, a forceful deteletion of the managed thing will
834
+ # occur. When set to `FALSE`, a non-forceful deletion of the managed
835
+ # thing will occur.
836
+ # @return [Boolean]
837
+ #
838
+ class DeleteManagedThingRequest < Struct.new(
839
+ :identifier,
840
+ :force)
841
+ SENSITIVE = []
842
+ include Aws::Structure
843
+ end
844
+
845
+ # @!attribute [rw] event_type
846
+ # The type of event triggering a device notification to the
847
+ # customer-managed destination.
848
+ # @return [String]
849
+ #
850
+ class DeleteNotificationConfigurationRequest < Struct.new(
851
+ :event_type)
852
+ SENSITIVE = []
853
+ include Aws::Structure
854
+ end
855
+
856
+ # @!attribute [rw] identifier
857
+ # The identifier of the over-the-air (OTA) task configuration.
858
+ # @return [String]
859
+ #
860
+ class DeleteOtaTaskConfigurationRequest < Struct.new(
861
+ :identifier)
862
+ SENSITIVE = []
863
+ include Aws::Structure
864
+ end
865
+
866
+ # @!attribute [rw] identifier
867
+ # The identifier of the over-the-air (OTA) task.
868
+ # @return [String]
869
+ #
870
+ class DeleteOtaTaskRequest < Struct.new(
871
+ :identifier)
872
+ SENSITIVE = []
873
+ include Aws::Structure
874
+ end
875
+
876
+ # @!attribute [rw] identifier
877
+ # The name of the provisioning template.
878
+ # @return [String]
879
+ #
880
+ class DeleteProvisioningProfileRequest < Struct.new(
881
+ :identifier)
882
+ SENSITIVE = []
883
+ include Aws::Structure
884
+ end
885
+
886
+ # Structure describing a destination for IoT managed integrations to
887
+ # deliver notifications for a device.
888
+ #
889
+ # @!attribute [rw] description
890
+ # The description of the customer-managed destination.
891
+ # @return [String]
892
+ #
893
+ # @!attribute [rw] delivery_destination_arn
894
+ # The Amazon Resource Name (ARN) of the customer-managed destination.
895
+ # @return [String]
896
+ #
897
+ # @!attribute [rw] delivery_destination_type
898
+ # The destination type for the customer-managed destination.
899
+ # @return [String]
900
+ #
901
+ # @!attribute [rw] name
902
+ # The name of the customer-managed destination.
903
+ # @return [String]
904
+ #
905
+ # @!attribute [rw] role_arn
906
+ # The Amazon Resource Name (ARN) of the delivery destination.
907
+ # @return [String]
908
+ #
909
+ class DestinationSummary < Struct.new(
910
+ :description,
911
+ :delivery_destination_arn,
912
+ :delivery_destination_type,
913
+ :name,
914
+ :role_arn)
915
+ SENSITIVE = []
916
+ include Aws::Structure
917
+ end
918
+
919
+ # List of event log configurations.
920
+ #
921
+ # @!attribute [rw] id
922
+ # The identifier of the event log configuration.
923
+ # @return [String]
924
+ #
925
+ # @!attribute [rw] resource_type
926
+ # The type of resource for the event log configuration.
927
+ # @return [String]
928
+ #
929
+ # @!attribute [rw] resource_id
930
+ # The identifier of the resource for the event log configuration.
931
+ # @return [String]
932
+ #
933
+ # @!attribute [rw] event_log_level
934
+ # The logging level for the event log configuration.
935
+ # @return [String]
936
+ #
937
+ class EventLogConfigurationSummary < Struct.new(
938
+ :id,
939
+ :resource_type,
940
+ :resource_id,
941
+ :event_log_level)
942
+ SENSITIVE = []
943
+ include Aws::Structure
944
+ end
945
+
946
+ # Structure representing exponential rate of rollout for an over-the-air
947
+ # (OTA) task.
948
+ #
949
+ # @!attribute [rw] base_rate_per_minute
950
+ # The base rate per minute for the rollout of an over-the-air (OTA)
951
+ # task.
952
+ # @return [Integer]
953
+ #
954
+ # @!attribute [rw] increment_factor
955
+ # The incremental factor for increasing the rollout rate of an
956
+ # over-the-air (OTA) task.
957
+ # @return [Float]
958
+ #
959
+ # @!attribute [rw] rate_increase_criteria
960
+ # The criteria for increasing the rollout rate of an over-the-air
961
+ # (OTA) task.
962
+ # @return [Types::RolloutRateIncreaseCriteria]
963
+ #
964
+ class ExponentialRolloutRate < Struct.new(
965
+ :base_rate_per_minute,
966
+ :increment_factor,
967
+ :rate_increase_criteria)
968
+ SENSITIVE = []
969
+ include Aws::Structure
970
+ end
971
+
972
+ # @!attribute [rw] identifier
973
+ # The identifier of the credential locker.
974
+ # @return [String]
975
+ #
976
+ class GetCredentialLockerRequest < Struct.new(
977
+ :identifier)
978
+ SENSITIVE = []
979
+ include Aws::Structure
980
+ end
981
+
982
+ # @!attribute [rw] id
983
+ # The identifier of the credential locker.
984
+ # @return [String]
985
+ #
986
+ # @!attribute [rw] arn
987
+ # The Amazon Resource Name (ARN) of the credential locker.
988
+ # @return [String]
989
+ #
990
+ # @!attribute [rw] name
991
+ # The name of the credential locker.
992
+ # @return [String]
993
+ #
994
+ # @!attribute [rw] created_at
995
+ # The timestamp value of when the credential locker requset occurred.
996
+ # @return [Time]
997
+ #
998
+ # @!attribute [rw] tags
999
+ # A set of key/value pairs that are used to manage the credential
1000
+ # locker.
1001
+ # @return [Hash<String,String>]
1002
+ #
1003
+ class GetCredentialLockerResponse < Struct.new(
1004
+ :id,
1005
+ :arn,
1006
+ :name,
1007
+ :created_at,
1008
+ :tags)
1009
+ SENSITIVE = [:name, :tags]
1010
+ include Aws::Structure
1011
+ end
1012
+
1013
+ # @api private
1014
+ #
1015
+ class GetCustomEndpointRequest < Aws::EmptyStructure; end
1016
+
1017
+ # @!attribute [rw] endpoint_address
1018
+ # The IoT managed integrations dedicated, custom endpoint for the
1019
+ # device to route traffic through.
1020
+ # @return [String]
1021
+ #
1022
+ class GetCustomEndpointResponse < Struct.new(
1023
+ :endpoint_address)
1024
+ SENSITIVE = []
1025
+ include Aws::Structure
1026
+ end
1027
+
1028
+ # @api private
1029
+ #
1030
+ class GetDefaultEncryptionConfigurationRequest < Aws::EmptyStructure; end
1031
+
1032
+ # @!attribute [rw] configuration_status
1033
+ # Provides the status of the default encryption configuration for an
1034
+ # Amazon Web Services account.
1035
+ # @return [Types::ConfigurationStatus]
1036
+ #
1037
+ # @!attribute [rw] encryption_type
1038
+ # The type of encryption used for the encryption configuration.
1039
+ # @return [String]
1040
+ #
1041
+ # @!attribute [rw] kms_key_arn
1042
+ # The Key Amazon Resource Name (ARN) of the AWS KMS key used for KMS
1043
+ # encryption if you use `KMS_BASED_ENCRYPTION`.
1044
+ # @return [String]
1045
+ #
1046
+ class GetDefaultEncryptionConfigurationResponse < Struct.new(
1047
+ :configuration_status,
1048
+ :encryption_type,
1049
+ :kms_key_arn)
1050
+ SENSITIVE = []
1051
+ include Aws::Structure
1052
+ end
1053
+
1054
+ # @!attribute [rw] name
1055
+ # The name of the customer-managed destination.
1056
+ # @return [String]
1057
+ #
1058
+ class GetDestinationRequest < Struct.new(
1059
+ :name)
1060
+ SENSITIVE = []
1061
+ include Aws::Structure
1062
+ end
1063
+
1064
+ # @!attribute [rw] description
1065
+ # The description of the customer-managed destination.
1066
+ # @return [String]
1067
+ #
1068
+ # @!attribute [rw] delivery_destination_arn
1069
+ # The Amazon Resource Name (ARN) of the customer-managed destination.
1070
+ # @return [String]
1071
+ #
1072
+ # @!attribute [rw] delivery_destination_type
1073
+ # The destination type for the customer-managed destination.
1074
+ # @return [String]
1075
+ #
1076
+ # @!attribute [rw] name
1077
+ # The name of the customer-managed destination.
1078
+ # @return [String]
1079
+ #
1080
+ # @!attribute [rw] role_arn
1081
+ # The Amazon Resource Name (ARN) of the delivery destination role.
1082
+ # @return [String]
1083
+ #
1084
+ # @!attribute [rw] created_at
1085
+ # The timestamp value of when the destination creation requset
1086
+ # occurred.
1087
+ # @return [Time]
1088
+ #
1089
+ # @!attribute [rw] updated_at
1090
+ # The timestamp value of when the destination update requset occurred.
1091
+ # @return [Time]
1092
+ #
1093
+ # @!attribute [rw] tags
1094
+ # A set of key/value pairs that are used to manage the
1095
+ # customer-managed destination.
1096
+ # @return [Hash<String,String>]
1097
+ #
1098
+ class GetDestinationResponse < Struct.new(
1099
+ :description,
1100
+ :delivery_destination_arn,
1101
+ :delivery_destination_type,
1102
+ :name,
1103
+ :role_arn,
1104
+ :created_at,
1105
+ :updated_at,
1106
+ :tags)
1107
+ SENSITIVE = [:tags]
1108
+ include Aws::Structure
1109
+ end
1110
+
1111
+ # @!attribute [rw] identifier
1112
+ # The id of the device discovery job request.
1113
+ # @return [String]
1114
+ #
1115
+ class GetDeviceDiscoveryRequest < Struct.new(
1116
+ :identifier)
1117
+ SENSITIVE = []
1118
+ include Aws::Structure
1119
+ end
1120
+
1121
+ # @!attribute [rw] id
1122
+ # The id of the device discovery job request.
1123
+ # @return [String]
1124
+ #
1125
+ # @!attribute [rw] arn
1126
+ # The Amazon Resource Name (ARN) of the device discovery job request.
1127
+ # @return [String]
1128
+ #
1129
+ # @!attribute [rw] discovery_type
1130
+ # The discovery type supporting the type of device to be discovered in
1131
+ # the device discovery job request.
1132
+ # @return [String]
1133
+ #
1134
+ # @!attribute [rw] status
1135
+ # The status of the device discovery job request.
1136
+ # @return [String]
1137
+ #
1138
+ # @!attribute [rw] started_at
1139
+ # The timestamp value for the start time of the device discovery.
1140
+ # @return [Time]
1141
+ #
1142
+ # @!attribute [rw] controller_id
1143
+ # The id of the end-user's IoT hub.
1144
+ # @return [String]
1145
+ #
1146
+ # @!attribute [rw] connector_association_id
1147
+ # The ID tracking the current discovery process for one connector
1148
+ # association.
1149
+ # @return [String]
1150
+ #
1151
+ # @!attribute [rw] finished_at
1152
+ # The timestamp value for the completion time of the device discovery.
1153
+ # @return [Time]
1154
+ #
1155
+ # @!attribute [rw] tags
1156
+ # A set of key/value pairs that are used to manage the device
1157
+ # discovery request.
1158
+ # @return [Hash<String,String>]
1159
+ #
1160
+ class GetDeviceDiscoveryResponse < Struct.new(
1161
+ :id,
1162
+ :arn,
1163
+ :discovery_type,
1164
+ :status,
1165
+ :started_at,
1166
+ :controller_id,
1167
+ :connector_association_id,
1168
+ :finished_at,
1169
+ :tags)
1170
+ SENSITIVE = [:tags]
1171
+ include Aws::Structure
1172
+ end
1173
+
1174
+ # @!attribute [rw] id
1175
+ # The identifier of the event log configuration.
1176
+ # @return [String]
1177
+ #
1178
+ class GetEventLogConfigurationRequest < Struct.new(
1179
+ :id)
1180
+ SENSITIVE = []
1181
+ include Aws::Structure
1182
+ end
1183
+
1184
+ # @!attribute [rw] id
1185
+ # The identifier of the event log configuration.
1186
+ # @return [String]
1187
+ #
1188
+ # @!attribute [rw] resource_type
1189
+ # The type of resource for the event log configuration.
1190
+ # @return [String]
1191
+ #
1192
+ # @!attribute [rw] resource_id
1193
+ # The identifier of the resource for the event log configuration.
1194
+ # @return [String]
1195
+ #
1196
+ # @!attribute [rw] event_log_level
1197
+ # The logging level for the event log configuration.
1198
+ # @return [String]
1199
+ #
1200
+ class GetEventLogConfigurationResponse < Struct.new(
1201
+ :id,
1202
+ :resource_type,
1203
+ :resource_id,
1204
+ :event_log_level)
1205
+ SENSITIVE = []
1206
+ include Aws::Structure
1207
+ end
1208
+
1209
+ # @api private
1210
+ #
1211
+ class GetHubConfigurationRequest < Aws::EmptyStructure; end
1212
+
1213
+ # @!attribute [rw] hub_token_timer_expiry_setting_in_seconds
1214
+ # A user-defined integer value that represents the hub token timer
1215
+ # expiry setting in seconds.
1216
+ # @return [Integer]
1217
+ #
1218
+ # @!attribute [rw] updated_at
1219
+ # The timestamp value of when the hub configuration was updated.
1220
+ # @return [Time]
1221
+ #
1222
+ class GetHubConfigurationResponse < Struct.new(
1223
+ :hub_token_timer_expiry_setting_in_seconds,
1224
+ :updated_at)
1225
+ SENSITIVE = []
1226
+ include Aws::Structure
1227
+ end
1228
+
1229
+ # @!attribute [rw] identifier
1230
+ # The id of the device.
1231
+ # @return [String]
1232
+ #
1233
+ class GetManagedThingCapabilitiesRequest < Struct.new(
1234
+ :identifier)
1235
+ SENSITIVE = []
1236
+ include Aws::Structure
1237
+ end
1238
+
1239
+ # @!attribute [rw] managed_thing_id
1240
+ # The id of the device.
1241
+ # @return [String]
1242
+ #
1243
+ # @!attribute [rw] capabilities
1244
+ # The capabilities of the device such as light bulb.
1245
+ # @return [String]
1246
+ #
1247
+ # @!attribute [rw] capability_report
1248
+ # A report of the capabilities for the managed thing.
1249
+ # @return [Types::CapabilityReport]
1250
+ #
1251
+ class GetManagedThingCapabilitiesResponse < Struct.new(
1252
+ :managed_thing_id,
1253
+ :capabilities,
1254
+ :capability_report)
1255
+ SENSITIVE = []
1256
+ include Aws::Structure
1257
+ end
1258
+
1259
+ # @!attribute [rw] identifier
1260
+ # The identifier of a managed thing.
1261
+ # @return [String]
1262
+ #
1263
+ class GetManagedThingConnectivityDataRequest < Struct.new(
1264
+ :identifier)
1265
+ SENSITIVE = []
1266
+ include Aws::Structure
1267
+ end
1268
+
1269
+ # @!attribute [rw] managed_thing_id
1270
+ # The id of a managed thing.
1271
+ # @return [String]
1272
+ #
1273
+ # @!attribute [rw] connected
1274
+ # The connectivity status for a managed thing.
1275
+ # @return [Boolean]
1276
+ #
1277
+ # @!attribute [rw] timestamp
1278
+ # The timestamp value of when the connectivity status for a managed
1279
+ # thing was last taken.
1280
+ # @return [Time]
1281
+ #
1282
+ # @!attribute [rw] disconnect_reason
1283
+ # The reason for the connectivity disconnect with the managed thing.
1284
+ # @return [String]
1285
+ #
1286
+ class GetManagedThingConnectivityDataResponse < Struct.new(
1287
+ :managed_thing_id,
1288
+ :connected,
1289
+ :timestamp,
1290
+ :disconnect_reason)
1291
+ SENSITIVE = []
1292
+ include Aws::Structure
1293
+ end
1294
+
1295
+ # @!attribute [rw] identifier
1296
+ # The managed thing id.
1297
+ # @return [String]
1298
+ #
1299
+ class GetManagedThingMetaDataRequest < Struct.new(
1300
+ :identifier)
1301
+ SENSITIVE = []
1302
+ include Aws::Structure
1303
+ end
1304
+
1305
+ # @!attribute [rw] managed_thing_id
1306
+ # The managed thing id.
1307
+ # @return [String]
1308
+ #
1309
+ # @!attribute [rw] meta_data
1310
+ # The metadata for the managed thing.
1311
+ # @return [Hash<String,String>]
1312
+ #
1313
+ class GetManagedThingMetaDataResponse < Struct.new(
1314
+ :managed_thing_id,
1315
+ :meta_data)
1316
+ SENSITIVE = []
1317
+ include Aws::Structure
1318
+ end
1319
+
1320
+ # @!attribute [rw] identifier
1321
+ # The id of the managed thing.
1322
+ # @return [String]
1323
+ #
1324
+ class GetManagedThingRequest < Struct.new(
1325
+ :identifier)
1326
+ SENSITIVE = []
1327
+ include Aws::Structure
1328
+ end
1329
+
1330
+ # @!attribute [rw] id
1331
+ # The id of the managed thing.
1332
+ # @return [String]
1333
+ #
1334
+ # @!attribute [rw] arn
1335
+ # The Amazon Resource Name (ARN) of the managed thing.
1336
+ # @return [String]
1337
+ #
1338
+ # @!attribute [rw] owner
1339
+ # Owner of the device, usually an indication of whom the device
1340
+ # belongs to. This value should not contain personal identifiable
1341
+ # information.
1342
+ # @return [String]
1343
+ #
1344
+ # @!attribute [rw] credential_locker_id
1345
+ # The identifier of the credential locker for the managed thing.
1346
+ # @return [String]
1347
+ #
1348
+ # @!attribute [rw] advertised_product_id
1349
+ # The id of the advertised product.
1350
+ # @return [String]
1351
+ #
1352
+ # @!attribute [rw] role
1353
+ # The type of device used. This will be the Amazon Web Services hub
1354
+ # controller, cloud device, or IoT device.
1355
+ # @return [String]
1356
+ #
1357
+ # @!attribute [rw] provisioning_status
1358
+ # The provisioning status of the device in the provisioning workflow
1359
+ # for onboarding to IoT managed integrations.
1360
+ # @return [String]
1361
+ #
1362
+ # @!attribute [rw] name
1363
+ # The name of the managed thing representing the physical device.
1364
+ # @return [String]
1365
+ #
1366
+ # @!attribute [rw] model
1367
+ # The model of the device.
1368
+ # @return [String]
1369
+ #
1370
+ # @!attribute [rw] brand
1371
+ # The brand of the device.
1372
+ # @return [String]
1373
+ #
1374
+ # @!attribute [rw] serial_number
1375
+ # The serial number of the device.
1376
+ # @return [String]
1377
+ #
1378
+ # @!attribute [rw] universal_product_code
1379
+ # The universal product code (UPC) of the device model. The UPC is
1380
+ # typically used in the United States of America and Canada.
1381
+ # @return [String]
1382
+ #
1383
+ # @!attribute [rw] international_article_number
1384
+ # The unique 13 digit number that identifies the managed thing.
1385
+ # @return [String]
1386
+ #
1387
+ # @!attribute [rw] connector_policy_id
1388
+ # The id of the connector policy.
1389
+ #
1390
+ # <note markdown="1"> This parameter is used for cloud-to-cloud devices only.
1391
+ #
1392
+ # </note>
1393
+ # @return [String]
1394
+ #
1395
+ # @!attribute [rw] connector_device_id
1396
+ # The third-party device id as defined by the connector. This device
1397
+ # id must not contain personal identifiable information (PII).
1398
+ #
1399
+ # <note markdown="1"> This parameter is used for cloud-to-cloud devices only.
1400
+ #
1401
+ # </note>
1402
+ # @return [String]
1403
+ #
1404
+ # @!attribute [rw] device_specific_key
1405
+ # A Zwave device-specific key used during device activation.
1406
+ #
1407
+ # <note markdown="1"> This parameter is used for Zwave devices only.
1408
+ #
1409
+ # </note>
1410
+ # @return [String]
1411
+ #
1412
+ # @!attribute [rw] mac_address
1413
+ # The media access control (MAC) address for the device represented by
1414
+ # the managed thing.
1415
+ #
1416
+ # <note markdown="1"> This parameter is used for Zigbee devices only.
1417
+ #
1418
+ # </note>
1419
+ # @return [String]
1420
+ #
1421
+ # @!attribute [rw] parent_controller_id
1422
+ # Id of the controller device used for the discovery job.
1423
+ # @return [String]
1424
+ #
1425
+ # @!attribute [rw] classification
1426
+ # The classification of the managed thing such as light bulb or
1427
+ # thermostat.
1428
+ # @return [String]
1429
+ #
1430
+ # @!attribute [rw] created_at
1431
+ # The timestamp value of when the device creation request occurred.
1432
+ # @return [Time]
1433
+ #
1434
+ # @!attribute [rw] updated_at
1435
+ # The timestamp value of when the managed thing was last updated at.
1436
+ # @return [Time]
1437
+ #
1438
+ # @!attribute [rw] activated_at
1439
+ # The timestampe value of when the device was activated.
1440
+ # @return [Time]
1441
+ #
1442
+ # @!attribute [rw] hub_network_mode
1443
+ # The network mode for the hub-connected device.
1444
+ # @return [String]
1445
+ #
1446
+ # @!attribute [rw] meta_data
1447
+ # The metadata for the managed thing.
1448
+ # @return [Hash<String,String>]
1449
+ #
1450
+ # @!attribute [rw] tags
1451
+ # A set of key/value pairs that are used to manage the managed thing.
1452
+ # @return [Hash<String,String>]
1453
+ #
1454
+ class GetManagedThingResponse < Struct.new(
1455
+ :id,
1456
+ :arn,
1457
+ :owner,
1458
+ :credential_locker_id,
1459
+ :advertised_product_id,
1460
+ :role,
1461
+ :provisioning_status,
1462
+ :name,
1463
+ :model,
1464
+ :brand,
1465
+ :serial_number,
1466
+ :universal_product_code,
1467
+ :international_article_number,
1468
+ :connector_policy_id,
1469
+ :connector_device_id,
1470
+ :device_specific_key,
1471
+ :mac_address,
1472
+ :parent_controller_id,
1473
+ :classification,
1474
+ :created_at,
1475
+ :updated_at,
1476
+ :activated_at,
1477
+ :hub_network_mode,
1478
+ :meta_data,
1479
+ :tags)
1480
+ SENSITIVE = [:owner, :model, :brand, :serial_number, :universal_product_code, :international_article_number, :connector_device_id, :device_specific_key, :mac_address, :classification, :tags]
1481
+ include Aws::Structure
1482
+ end
1483
+
1484
+ # @!attribute [rw] managed_thing_id
1485
+ # The id of the device.
1486
+ # @return [String]
1487
+ #
1488
+ class GetManagedThingStateRequest < Struct.new(
1489
+ :managed_thing_id)
1490
+ SENSITIVE = []
1491
+ include Aws::Structure
1492
+ end
1493
+
1494
+ # @!attribute [rw] endpoints
1495
+ # The device endpoint.
1496
+ # @return [Array<Types::StateEndpoint>]
1497
+ #
1498
+ class GetManagedThingStateResponse < Struct.new(
1499
+ :endpoints)
1500
+ SENSITIVE = []
1501
+ include Aws::Structure
1502
+ end
1503
+
1504
+ # @!attribute [rw] event_type
1505
+ # The type of event triggering a device notification to the
1506
+ # customer-managed destination.
1507
+ # @return [String]
1508
+ #
1509
+ class GetNotificationConfigurationRequest < Struct.new(
1510
+ :event_type)
1511
+ SENSITIVE = []
1512
+ include Aws::Structure
1513
+ end
1514
+
1515
+ # @!attribute [rw] event_type
1516
+ # The type of event triggering a device notification to the
1517
+ # customer-managed destination.
1518
+ # @return [String]
1519
+ #
1520
+ # @!attribute [rw] destination_name
1521
+ # The name of the destination for the notification configuration.
1522
+ # @return [String]
1523
+ #
1524
+ # @!attribute [rw] created_at
1525
+ # The timestamp value of when the notification configuration was
1526
+ # created.
1527
+ # @return [Time]
1528
+ #
1529
+ # @!attribute [rw] updated_at
1530
+ # The timestamp value of when the notification configuration was last
1531
+ # updated.
1532
+ # @return [Time]
1533
+ #
1534
+ # @!attribute [rw] tags
1535
+ # A set of key/value pairs that are used to manage the notification
1536
+ # configuration.
1537
+ # @return [Hash<String,String>]
1538
+ #
1539
+ class GetNotificationConfigurationResponse < Struct.new(
1540
+ :event_type,
1541
+ :destination_name,
1542
+ :created_at,
1543
+ :updated_at,
1544
+ :tags)
1545
+ SENSITIVE = [:tags]
1546
+ include Aws::Structure
1547
+ end
1548
+
1549
+ # @!attribute [rw] identifier
1550
+ # The over-the-air (OTA) task configuration id.
1551
+ # @return [String]
1552
+ #
1553
+ class GetOtaTaskConfigurationRequest < Struct.new(
1554
+ :identifier)
1555
+ SENSITIVE = []
1556
+ include Aws::Structure
1557
+ end
1558
+
1559
+ # @!attribute [rw] task_configuration_id
1560
+ # The over-the-air (OTA) task configuration id.
1561
+ # @return [String]
1562
+ #
1563
+ # @!attribute [rw] name
1564
+ # The name of the over-the-air (OTA) task configuration.
1565
+ # @return [String]
1566
+ #
1567
+ # @!attribute [rw] push_config
1568
+ # Describes the type of configuration used for the over-the-air (OTA)
1569
+ # task.
1570
+ # @return [Types::PushConfig]
1571
+ #
1572
+ # @!attribute [rw] description
1573
+ # A description of the over-the-air (OTA) task configuration.
1574
+ # @return [String]
1575
+ #
1576
+ # @!attribute [rw] created_at
1577
+ # The timestamp value of when the over-the-air (OTA) task
1578
+ # configuration was created at.
1579
+ # @return [Time]
1580
+ #
1581
+ class GetOtaTaskConfigurationResponse < Struct.new(
1582
+ :task_configuration_id,
1583
+ :name,
1584
+ :push_config,
1585
+ :description,
1586
+ :created_at)
1587
+ SENSITIVE = [:name]
1588
+ include Aws::Structure
1589
+ end
1590
+
1591
+ # @!attribute [rw] identifier
1592
+ # The over-the-air (OTA) task id.
1593
+ # @return [String]
1594
+ #
1595
+ class GetOtaTaskRequest < Struct.new(
1596
+ :identifier)
1597
+ SENSITIVE = []
1598
+ include Aws::Structure
1599
+ end
1600
+
1601
+ # @!attribute [rw] task_id
1602
+ # The id of the over-the-air (OTA) task.
1603
+ # @return [String]
1604
+ #
1605
+ # @!attribute [rw] task_arn
1606
+ # The Amazon Resource Name (ARN) of the over-the-air (OTA) task
1607
+ # @return [String]
1608
+ #
1609
+ # @!attribute [rw] description
1610
+ # The description of the over-the-air (OTA) task.
1611
+ # @return [String]
1612
+ #
1613
+ # @!attribute [rw] s3_url
1614
+ # The URL to the Amazon S3 bucket where the over-the-air (OTA) task is
1615
+ # stored.
1616
+ # @return [String]
1617
+ #
1618
+ # @!attribute [rw] protocol
1619
+ # The connection protocol the over-the-air (OTA) task uses to update
1620
+ # the device.
1621
+ # @return [String]
1622
+ #
1623
+ # @!attribute [rw] ota_type
1624
+ # The frequency type for the over-the-air (OTA) task.
1625
+ # @return [String]
1626
+ #
1627
+ # @!attribute [rw] ota_target_query_string
1628
+ # The query string to add things to the thing group.
1629
+ # @return [String]
1630
+ #
1631
+ # @!attribute [rw] ota_mechanism
1632
+ # The deployment mechanism for the over-the-air (OTA) task.
1633
+ # @return [String]
1634
+ #
1635
+ # @!attribute [rw] target
1636
+ # The device targeted for the over-the-air (OTA) task.
1637
+ # @return [Array<String>]
1638
+ #
1639
+ # @!attribute [rw] created_at
1640
+ # The timestamp value of when the over-the-air (OTA) task was created.
1641
+ # @return [Time]
1642
+ #
1643
+ # @!attribute [rw] last_updated_at
1644
+ # The timestamp value of when the over-the-air (OTA) task was last
1645
+ # updated at.
1646
+ # @return [Time]
1647
+ #
1648
+ # @!attribute [rw] task_configuration_id
1649
+ # The identifier for the over-the-air (OTA) task configuration.
1650
+ # @return [String]
1651
+ #
1652
+ # @!attribute [rw] task_processing_details
1653
+ # The processing details of all over-the-air (OTA) tasks.
1654
+ # @return [Types::TaskProcessingDetails]
1655
+ #
1656
+ # @!attribute [rw] ota_scheduling_config
1657
+ # Over-the-air (OTA) task scheduling config.
1658
+ # @return [Types::OtaTaskSchedulingConfig]
1659
+ #
1660
+ # @!attribute [rw] ota_task_execution_retry_config
1661
+ # Over-the-air (OTA) task retry config.
1662
+ # @return [Types::OtaTaskExecutionRetryConfig]
1663
+ #
1664
+ # @!attribute [rw] status
1665
+ # The status of the over-the-air (OTA) task.
1666
+ # @return [String]
1667
+ #
1668
+ class GetOtaTaskResponse < Struct.new(
1669
+ :task_id,
1670
+ :task_arn,
1671
+ :description,
1672
+ :s3_url,
1673
+ :protocol,
1674
+ :ota_type,
1675
+ :ota_target_query_string,
1676
+ :ota_mechanism,
1677
+ :target,
1678
+ :created_at,
1679
+ :last_updated_at,
1680
+ :task_configuration_id,
1681
+ :task_processing_details,
1682
+ :ota_scheduling_config,
1683
+ :ota_task_execution_retry_config,
1684
+ :status)
1685
+ SENSITIVE = []
1686
+ include Aws::Structure
1687
+ end
1688
+
1689
+ # @!attribute [rw] identifier
1690
+ # The provisioning template the device uses for the provisioning
1691
+ # process.
1692
+ # @return [String]
1693
+ #
1694
+ class GetProvisioningProfileRequest < Struct.new(
1695
+ :identifier)
1696
+ SENSITIVE = []
1697
+ include Aws::Structure
1698
+ end
1699
+
1700
+ # @!attribute [rw] arn
1701
+ # The Amazon Resource Name (ARN) of the provisioning template used in
1702
+ # the provisioning profile.
1703
+ # @return [String]
1704
+ #
1705
+ # @!attribute [rw] name
1706
+ # The name of the provisioning template.
1707
+ # @return [String]
1708
+ #
1709
+ # @!attribute [rw] provisioning_type
1710
+ # The type of provisioning workflow the device uses for onboarding to
1711
+ # IoT managed integrations.
1712
+ # @return [String]
1713
+ #
1714
+ # @!attribute [rw] id
1715
+ # The provisioning profile id..
1716
+ # @return [String]
1717
+ #
1718
+ # @!attribute [rw] claim_certificate
1719
+ # The id of the claim certificate.
1720
+ # @return [String]
1721
+ #
1722
+ # @!attribute [rw] tags
1723
+ # A set of key/value pairs that are used to manage the provisioning
1724
+ # profile.
1725
+ # @return [Hash<String,String>]
1726
+ #
1727
+ class GetProvisioningProfileResponse < Struct.new(
1728
+ :arn,
1729
+ :name,
1730
+ :provisioning_type,
1731
+ :id,
1732
+ :claim_certificate,
1733
+ :tags)
1734
+ SENSITIVE = [:claim_certificate, :tags]
1735
+ include Aws::Structure
1736
+ end
1737
+
1738
+ # @!attribute [rw] managed_thing_id
1739
+ # The id for a managed thing.
1740
+ # @return [String]
1741
+ #
1742
+ class GetRuntimeLogConfigurationRequest < Struct.new(
1743
+ :managed_thing_id)
1744
+ SENSITIVE = []
1745
+ include Aws::Structure
1746
+ end
1747
+
1748
+ # @!attribute [rw] managed_thing_id
1749
+ # The id for a managed thing.
1750
+ # @return [String]
1751
+ #
1752
+ # @!attribute [rw] runtime_log_configurations
1753
+ # The runtime log configuration for a managed thing.
1754
+ # @return [Types::RuntimeLogConfigurations]
1755
+ #
1756
+ class GetRuntimeLogConfigurationResponse < Struct.new(
1757
+ :managed_thing_id,
1758
+ :runtime_log_configurations)
1759
+ SENSITIVE = []
1760
+ include Aws::Structure
1761
+ end
1762
+
1763
+ # @!attribute [rw] type
1764
+ # The type of schema version.
1765
+ # @return [String]
1766
+ #
1767
+ # @!attribute [rw] schema_versioned_id
1768
+ # Schema id with a version specified. If the version is missing, it
1769
+ # defaults to latest version.
1770
+ # @return [String]
1771
+ #
1772
+ # @!attribute [rw] format
1773
+ # The format of the schema version.
1774
+ # @return [String]
1775
+ #
1776
+ class GetSchemaVersionRequest < Struct.new(
1777
+ :type,
1778
+ :schema_versioned_id,
1779
+ :format)
1780
+ SENSITIVE = []
1781
+ include Aws::Structure
1782
+ end
1783
+
1784
+ # @!attribute [rw] schema_id
1785
+ # The id of the schema version.
1786
+ # @return [String]
1787
+ #
1788
+ # @!attribute [rw] type
1789
+ # The type of schema version.
1790
+ # @return [String]
1791
+ #
1792
+ # @!attribute [rw] description
1793
+ # The description of the schema version.
1794
+ # @return [String]
1795
+ #
1796
+ # @!attribute [rw] namespace
1797
+ # The name of the schema version.
1798
+ # @return [String]
1799
+ #
1800
+ # @!attribute [rw] semantic_version
1801
+ # The schema version. If this is left blank, it defaults to the latest
1802
+ # version.
1803
+ # @return [String]
1804
+ #
1805
+ # @!attribute [rw] visibility
1806
+ # The visibility of the schema version.
1807
+ # @return [String]
1808
+ #
1809
+ # @!attribute [rw] schema
1810
+ # The schema of the schema version.
1811
+ # @return [Hash,Array,String,Numeric,Boolean]
1812
+ #
1813
+ class GetSchemaVersionResponse < Struct.new(
1814
+ :schema_id,
1815
+ :type,
1816
+ :description,
1817
+ :namespace,
1818
+ :semantic_version,
1819
+ :visibility,
1820
+ :schema)
1821
+ SENSITIVE = []
1822
+ include Aws::Structure
1823
+ end
1824
+
1825
+ # An unexpected error has occurred.
1826
+ #
1827
+ # @!attribute [rw] message
1828
+ # @return [String]
1829
+ #
1830
+ class InternalFailureException < Struct.new(
1831
+ :message)
1832
+ SENSITIVE = []
1833
+ include Aws::Structure
1834
+ end
1835
+
1836
+ # Internal error from the service that indicates an unexpected error or
1837
+ # that the service is unavailable.
1838
+ #
1839
+ # @!attribute [rw] message
1840
+ # @return [String]
1841
+ #
1842
+ class InternalServerException < Struct.new(
1843
+ :message)
1844
+ SENSITIVE = []
1845
+ include Aws::Structure
1846
+ end
1847
+
1848
+ # @!attribute [rw] next_token
1849
+ # A token that can be used to retrieve the next set of results.
1850
+ # @return [String]
1851
+ #
1852
+ # @!attribute [rw] max_results
1853
+ # The maximum number of results to return at one time.
1854
+ # @return [Integer]
1855
+ #
1856
+ class ListCredentialLockersRequest < Struct.new(
1857
+ :next_token,
1858
+ :max_results)
1859
+ SENSITIVE = []
1860
+ include Aws::Structure
1861
+ end
1862
+
1863
+ # @!attribute [rw] items
1864
+ # The list of credential lockers.
1865
+ # @return [Array<Types::CredentialLockerSummary>]
1866
+ #
1867
+ # @!attribute [rw] next_token
1868
+ # A token that can be used to retrieve the next set of results.
1869
+ # @return [String]
1870
+ #
1871
+ class ListCredentialLockersResponse < Struct.new(
1872
+ :items,
1873
+ :next_token)
1874
+ SENSITIVE = []
1875
+ include Aws::Structure
1876
+ end
1877
+
1878
+ # @!attribute [rw] next_token
1879
+ # A token that can be used to retrieve the next set of results.
1880
+ # @return [String]
1881
+ #
1882
+ # @!attribute [rw] max_results
1883
+ # The maximum number of results to return at one time.
1884
+ # @return [Integer]
1885
+ #
1886
+ class ListDestinationsRequest < Struct.new(
1887
+ :next_token,
1888
+ :max_results)
1889
+ SENSITIVE = []
1890
+ include Aws::Structure
1891
+ end
1892
+
1893
+ # @!attribute [rw] destination_list
1894
+ # The list of destinations.
1895
+ # @return [Array<Types::DestinationSummary>]
1896
+ #
1897
+ # @!attribute [rw] next_token
1898
+ # A token that can be used to retrieve the next set of results.
1899
+ # @return [String]
1900
+ #
1901
+ class ListDestinationsResponse < Struct.new(
1902
+ :destination_list,
1903
+ :next_token)
1904
+ SENSITIVE = []
1905
+ include Aws::Structure
1906
+ end
1907
+
1908
+ # @!attribute [rw] next_token
1909
+ # A token that can be used to retrieve the next set of results.
1910
+ # @return [String]
1911
+ #
1912
+ # @!attribute [rw] max_results
1913
+ # The maximum number of results to return at one time.
1914
+ # @return [Integer]
1915
+ #
1916
+ class ListEventLogConfigurationsRequest < Struct.new(
1917
+ :next_token,
1918
+ :max_results)
1919
+ SENSITIVE = []
1920
+ include Aws::Structure
1921
+ end
1922
+
1923
+ # @!attribute [rw] event_log_configuration_list
1924
+ # A list of each event log configuration and pertinent information.
1925
+ # @return [Array<Types::EventLogConfigurationSummary>]
1926
+ #
1927
+ # @!attribute [rw] next_token
1928
+ # A token that can be used to retrieve the next set of results.
1929
+ # @return [String]
1930
+ #
1931
+ class ListEventLogConfigurationsResponse < Struct.new(
1932
+ :event_log_configuration_list,
1933
+ :next_token)
1934
+ SENSITIVE = []
1935
+ include Aws::Structure
1936
+ end
1937
+
1938
+ # @!attribute [rw] identifier
1939
+ # The managed thing id.
1940
+ # @return [String]
1941
+ #
1942
+ # @!attribute [rw] endpoint_id_filter
1943
+ # Filter on an endpoint id.
1944
+ # @return [String]
1945
+ #
1946
+ # @!attribute [rw] capability_id_filter
1947
+ # Filter on a capability id.
1948
+ # @return [String]
1949
+ #
1950
+ # @!attribute [rw] next_token
1951
+ # A token that can be used to retrieve the next set of results.
1952
+ # @return [String]
1953
+ #
1954
+ # @!attribute [rw] max_results
1955
+ # The maximum number of results to return at one time.
1956
+ # @return [Integer]
1957
+ #
1958
+ class ListManagedThingSchemasRequest < Struct.new(
1959
+ :identifier,
1960
+ :endpoint_id_filter,
1961
+ :capability_id_filter,
1962
+ :next_token,
1963
+ :max_results)
1964
+ SENSITIVE = []
1965
+ include Aws::Structure
1966
+ end
1967
+
1968
+ # @!attribute [rw] items
1969
+ # The list of managed thing schemas.
1970
+ # @return [Array<Types::ManagedThingSchemaListItem>]
1971
+ #
1972
+ # @!attribute [rw] next_token
1973
+ # A token that can be used to retrieve the next set of results.
1974
+ # @return [String]
1975
+ #
1976
+ class ListManagedThingSchemasResponse < Struct.new(
1977
+ :items,
1978
+ :next_token)
1979
+ SENSITIVE = []
1980
+ include Aws::Structure
1981
+ end
1982
+
1983
+ # @!attribute [rw] owner_filter
1984
+ # Filter on device owners when listing managed things.
1985
+ # @return [String]
1986
+ #
1987
+ # @!attribute [rw] credential_locker_filter
1988
+ # Filter on a credential locker for a managed thing.
1989
+ # @return [String]
1990
+ #
1991
+ # @!attribute [rw] role_filter
1992
+ # Filter on the type of device used. This will be the Amazon Web
1993
+ # Services hub controller, cloud device, or IoT device.
1994
+ # @return [String]
1995
+ #
1996
+ # @!attribute [rw] parent_controller_identifier_filter
1997
+ # Filter on a parent controller id for a managed thing.
1998
+ # @return [String]
1999
+ #
2000
+ # @!attribute [rw] connector_policy_id_filter
2001
+ # Filter on a connector policy id for a managed thing.
2002
+ # @return [String]
2003
+ #
2004
+ # @!attribute [rw] serial_number_filter
2005
+ # Filter on the serial number of the device.
2006
+ # @return [String]
2007
+ #
2008
+ # @!attribute [rw] provisioning_status_filter
2009
+ # Filter on the status of the device.
2010
+ # @return [String]
2011
+ #
2012
+ # @!attribute [rw] next_token
2013
+ # A token that can be used to retrieve the next set of results.
2014
+ # @return [String]
2015
+ #
2016
+ # @!attribute [rw] max_results
2017
+ # The maximum number of results to return at one time.
2018
+ # @return [Integer]
2019
+ #
2020
+ class ListManagedThingsRequest < Struct.new(
2021
+ :owner_filter,
2022
+ :credential_locker_filter,
2023
+ :role_filter,
2024
+ :parent_controller_identifier_filter,
2025
+ :connector_policy_id_filter,
2026
+ :serial_number_filter,
2027
+ :provisioning_status_filter,
2028
+ :next_token,
2029
+ :max_results)
2030
+ SENSITIVE = [:owner_filter, :serial_number_filter]
2031
+ include Aws::Structure
2032
+ end
2033
+
2034
+ # @!attribute [rw] items
2035
+ # The list of managed things.
2036
+ # @return [Array<Types::ManagedThingSummary>]
2037
+ #
2038
+ # @!attribute [rw] next_token
2039
+ # A token that can be used to retrieve the next set of results.
2040
+ # @return [String]
2041
+ #
2042
+ class ListManagedThingsResponse < Struct.new(
2043
+ :items,
2044
+ :next_token)
2045
+ SENSITIVE = []
2046
+ include Aws::Structure
2047
+ end
2048
+
2049
+ # @!attribute [rw] max_results
2050
+ # The maximum number of results to return at one time.
2051
+ # @return [Integer]
2052
+ #
2053
+ # @!attribute [rw] next_token
2054
+ # A token that can be used to retrieve the next set of results.
2055
+ # @return [String]
2056
+ #
2057
+ class ListNotificationConfigurationsRequest < Struct.new(
2058
+ :max_results,
2059
+ :next_token)
2060
+ SENSITIVE = []
2061
+ include Aws::Structure
2062
+ end
2063
+
2064
+ # @!attribute [rw] notification_configuration_list
2065
+ # The list of notification configurations.
2066
+ # @return [Array<Types::NotificationConfigurationSummary>]
2067
+ #
2068
+ # @!attribute [rw] next_token
2069
+ # A token that can be used to retrieve the next set of results.
2070
+ # @return [String]
2071
+ #
2072
+ class ListNotificationConfigurationsResponse < Struct.new(
2073
+ :notification_configuration_list,
2074
+ :next_token)
2075
+ SENSITIVE = []
2076
+ include Aws::Structure
2077
+ end
2078
+
2079
+ # @!attribute [rw] next_token
2080
+ # A token that can be used to retrieve the next set of results.
2081
+ # @return [String]
2082
+ #
2083
+ # @!attribute [rw] max_results
2084
+ # The maximum number of results to return at one time.
2085
+ # @return [Integer]
2086
+ #
2087
+ class ListOtaTaskConfigurationsRequest < Struct.new(
2088
+ :next_token,
2089
+ :max_results)
2090
+ SENSITIVE = []
2091
+ include Aws::Structure
2092
+ end
2093
+
2094
+ # @!attribute [rw] items
2095
+ # The list of the over-the-air (OTA) task configurations.
2096
+ # @return [Array<Types::OtaTaskConfigurationSummary>]
2097
+ #
2098
+ # @!attribute [rw] next_token
2099
+ # A token that can be used to retrieve the next set of results.
2100
+ # @return [String]
2101
+ #
2102
+ class ListOtaTaskConfigurationsResponse < Struct.new(
2103
+ :items,
2104
+ :next_token)
2105
+ SENSITIVE = []
2106
+ include Aws::Structure
2107
+ end
2108
+
2109
+ # @!attribute [rw] identifier
2110
+ # The over-the-air (OTA) task id.
2111
+ # @return [String]
2112
+ #
2113
+ # @!attribute [rw] next_token
2114
+ # A token that can be used to retrieve the next set of results.
2115
+ # @return [String]
2116
+ #
2117
+ # @!attribute [rw] max_results
2118
+ # The maximum number of results to return at one time.
2119
+ # @return [Integer]
2120
+ #
2121
+ class ListOtaTaskExecutionsRequest < Struct.new(
2122
+ :identifier,
2123
+ :next_token,
2124
+ :max_results)
2125
+ SENSITIVE = []
2126
+ include Aws::Structure
2127
+ end
2128
+
2129
+ # @!attribute [rw] execution_summaries
2130
+ # A list of all of the over-the-air (OTA) task executions.
2131
+ # @return [Array<Types::OtaTaskExecutionSummaries>]
2132
+ #
2133
+ # @!attribute [rw] next_token
2134
+ # A token that can be used to retrieve the next set of results.
2135
+ # @return [String]
2136
+ #
2137
+ class ListOtaTaskExecutionsResponse < Struct.new(
2138
+ :execution_summaries,
2139
+ :next_token)
2140
+ SENSITIVE = []
2141
+ include Aws::Structure
2142
+ end
2143
+
2144
+ # @!attribute [rw] next_token
2145
+ # A token that can be used to retrieve the next set of results.
2146
+ # @return [String]
2147
+ #
2148
+ # @!attribute [rw] max_results
2149
+ # The maximum number of results to return at one time.
2150
+ # @return [Integer]
2151
+ #
2152
+ class ListOtaTasksRequest < Struct.new(
2153
+ :next_token,
2154
+ :max_results)
2155
+ SENSITIVE = []
2156
+ include Aws::Structure
2157
+ end
2158
+
2159
+ # @!attribute [rw] tasks
2160
+ # A list of all of the over-the-air (OTA) tasks.
2161
+ # @return [Array<Types::OtaTaskSummary>]
2162
+ #
2163
+ # @!attribute [rw] next_token
2164
+ # A token that can be used to retrieve the next set of results.
2165
+ # @return [String]
2166
+ #
2167
+ class ListOtaTasksResponse < Struct.new(
2168
+ :tasks,
2169
+ :next_token)
2170
+ SENSITIVE = []
2171
+ include Aws::Structure
2172
+ end
2173
+
2174
+ # @!attribute [rw] next_token
2175
+ # A token that can be used to retrieve the next set of results.
2176
+ # @return [String]
2177
+ #
2178
+ # @!attribute [rw] max_results
2179
+ # The maximum number of results to return at one time.
2180
+ # @return [Integer]
2181
+ #
2182
+ class ListProvisioningProfilesRequest < Struct.new(
2183
+ :next_token,
2184
+ :max_results)
2185
+ SENSITIVE = []
2186
+ include Aws::Structure
2187
+ end
2188
+
2189
+ # @!attribute [rw] items
2190
+ # The list of provisioning profiles.
2191
+ # @return [Array<Types::ProvisioningProfileSummary>]
2192
+ #
2193
+ # @!attribute [rw] next_token
2194
+ # A token that can be used to retrieve the next set of results.
2195
+ # @return [String]
2196
+ #
2197
+ class ListProvisioningProfilesResponse < Struct.new(
2198
+ :items,
2199
+ :next_token)
2200
+ SENSITIVE = []
2201
+ include Aws::Structure
2202
+ end
2203
+
2204
+ # @!attribute [rw] type
2205
+ # Filter on the type of schema version.
2206
+ # @return [String]
2207
+ #
2208
+ # @!attribute [rw] max_results
2209
+ # The maximum number of results to return at one time.
2210
+ # @return [Integer]
2211
+ #
2212
+ # @!attribute [rw] next_token
2213
+ # A token that can be used to retrieve the next set of results.
2214
+ # @return [String]
2215
+ #
2216
+ # @!attribute [rw] schema_id
2217
+ # Filter on the id of the schema version.
2218
+ # @return [String]
2219
+ #
2220
+ # @!attribute [rw] namespace
2221
+ # Filter on the name of the schema version.
2222
+ # @return [String]
2223
+ #
2224
+ # @!attribute [rw] visibility
2225
+ # The visibility of the schema version.
2226
+ # @return [String]
2227
+ #
2228
+ # @!attribute [rw] semantic_version
2229
+ # The schema version. If this is left blank, it defaults to the latest
2230
+ # version.
2231
+ # @return [String]
2232
+ #
2233
+ class ListSchemaVersionsRequest < Struct.new(
2234
+ :type,
2235
+ :max_results,
2236
+ :next_token,
2237
+ :schema_id,
2238
+ :namespace,
2239
+ :visibility,
2240
+ :semantic_version)
2241
+ SENSITIVE = []
2242
+ include Aws::Structure
2243
+ end
2244
+
2245
+ # @!attribute [rw] items
2246
+ # The list of schema versions.
2247
+ # @return [Array<Types::SchemaVersionListItem>]
2248
+ #
2249
+ # @!attribute [rw] next_token
2250
+ # A token that can be used to retrieve the next set of results.
2251
+ # @return [String]
2252
+ #
2253
+ class ListSchemaVersionsResponse < Struct.new(
2254
+ :items,
2255
+ :next_token)
2256
+ SENSITIVE = []
2257
+ include Aws::Structure
2258
+ end
2259
+
2260
+ # Structure representing one schema item associated with a managed
2261
+ # thing.
2262
+ #
2263
+ # @!attribute [rw] endpoint_id
2264
+ # The id of the endpoint for a managed thing.
2265
+ # @return [String]
2266
+ #
2267
+ # @!attribute [rw] capability_id
2268
+ # The id of the capability for a managed thing.
2269
+ # @return [String]
2270
+ #
2271
+ # @!attribute [rw] schema
2272
+ # The validation schema for one schema item associated with a managed
2273
+ # thing.
2274
+ # @return [Hash,Array,String,Numeric,Boolean]
2275
+ #
2276
+ class ManagedThingSchemaListItem < Struct.new(
2277
+ :endpoint_id,
2278
+ :capability_id,
2279
+ :schema)
2280
+ SENSITIVE = []
2281
+ include Aws::Structure
2282
+ end
2283
+
2284
+ # Structure representing one managed thing.
2285
+ #
2286
+ # @!attribute [rw] id
2287
+ # The id of the device.
2288
+ # @return [String]
2289
+ #
2290
+ # @!attribute [rw] arn
2291
+ # The Amazon Resource Name (ARN) of the managed thing.
2292
+ # @return [String]
2293
+ #
2294
+ # @!attribute [rw] advertised_product_id
2295
+ # The id of the advertised product.
2296
+ # @return [String]
2297
+ #
2298
+ # @!attribute [rw] brand
2299
+ # The brand of the device.
2300
+ # @return [String]
2301
+ #
2302
+ # @!attribute [rw] classification
2303
+ # The classification of the managed thing such as light bulb or
2304
+ # thermostat.
2305
+ # @return [String]
2306
+ #
2307
+ # @!attribute [rw] connector_device_id
2308
+ # The third-party device id as defined by the connector. This device
2309
+ # id must not contain personal identifiable information (PII).
2310
+ #
2311
+ # <note markdown="1"> This parameter is used for cloud-to-cloud devices only.
2312
+ #
2313
+ # </note>
2314
+ # @return [String]
2315
+ #
2316
+ # @!attribute [rw] connector_policy_id
2317
+ # The id of the connector policy.
2318
+ #
2319
+ # <note markdown="1"> This parameter is used for cloud-to-cloud devices only.
2320
+ #
2321
+ # </note>
2322
+ # @return [String]
2323
+ #
2324
+ # @!attribute [rw] model
2325
+ # The model of the device.
2326
+ # @return [String]
2327
+ #
2328
+ # @!attribute [rw] name
2329
+ # The name of the managed thing representing the physical device.
2330
+ # @return [String]
2331
+ #
2332
+ # @!attribute [rw] owner
2333
+ # Owner of the device, usually an indication of whom the device
2334
+ # belongs to. This value should not contain personal identifiable
2335
+ # information.
2336
+ # @return [String]
2337
+ #
2338
+ # @!attribute [rw] credential_locker_id
2339
+ # The identifier of the credential locker for the managed thing.
2340
+ # @return [String]
2341
+ #
2342
+ # @!attribute [rw] parent_controller_id
2343
+ # Id of the controller device used for the discovery job.
2344
+ # @return [String]
2345
+ #
2346
+ # @!attribute [rw] provisioning_status
2347
+ # The provisioning status of the device in the provisioning workflow
2348
+ # for onboarding to IoT managed integrations.
2349
+ # @return [String]
2350
+ #
2351
+ # @!attribute [rw] role
2352
+ # The type of device used. This will be the Amazon Web Services hub
2353
+ # controller, cloud device, or IoT device.
2354
+ # @return [String]
2355
+ #
2356
+ # @!attribute [rw] serial_number
2357
+ # The serial number of the device.
2358
+ # @return [String]
2359
+ #
2360
+ # @!attribute [rw] created_at
2361
+ # The timestamp value of when the device creation request occurred.
2362
+ # @return [Time]
2363
+ #
2364
+ # @!attribute [rw] updated_at
2365
+ # The timestamp value of when the managed thing was last updated at.
2366
+ # @return [Time]
2367
+ #
2368
+ # @!attribute [rw] activated_at
2369
+ # The timestampe value of when the managed thing was activated at.
2370
+ # @return [Time]
2371
+ #
2372
+ class ManagedThingSummary < Struct.new(
2373
+ :id,
2374
+ :arn,
2375
+ :advertised_product_id,
2376
+ :brand,
2377
+ :classification,
2378
+ :connector_device_id,
2379
+ :connector_policy_id,
2380
+ :model,
2381
+ :name,
2382
+ :owner,
2383
+ :credential_locker_id,
2384
+ :parent_controller_id,
2385
+ :provisioning_status,
2386
+ :role,
2387
+ :serial_number,
2388
+ :created_at,
2389
+ :updated_at,
2390
+ :activated_at)
2391
+ SENSITIVE = [:brand, :classification, :connector_device_id, :model, :owner, :serial_number]
2392
+ include Aws::Structure
2393
+ end
2394
+
2395
+ # Structure describing a notification configuration.
2396
+ #
2397
+ # @!attribute [rw] event_type
2398
+ # The type of event triggering a device notification to the
2399
+ # customer-managed destination.
2400
+ # @return [String]
2401
+ #
2402
+ # @!attribute [rw] destination_name
2403
+ # The name of the destination for the notification configuration.
2404
+ # @return [String]
2405
+ #
2406
+ class NotificationConfigurationSummary < Struct.new(
2407
+ :event_type,
2408
+ :destination_name)
2409
+ SENSITIVE = []
2410
+ include Aws::Structure
2411
+ end
2412
+
2413
+ # Over-the-air (OTA) task abort config.
2414
+ #
2415
+ # @!attribute [rw] abort_config_criteria_list
2416
+ # The list of criteria for the abort config.
2417
+ # @return [Array<Types::AbortConfigCriteria>]
2418
+ #
2419
+ class OtaTaskAbortConfig < Struct.new(
2420
+ :abort_config_criteria_list)
2421
+ SENSITIVE = []
2422
+ include Aws::Structure
2423
+ end
2424
+
2425
+ # Structure representing one over-the-air (OTA) task configuration.
2426
+ #
2427
+ # @!attribute [rw] task_configuration_id
2428
+ # The id of the over-the-air (OTA) task configuration
2429
+ # @return [String]
2430
+ #
2431
+ # @!attribute [rw] name
2432
+ # The name of the over-the-air (OTA) task configuration.
2433
+ # @return [String]
2434
+ #
2435
+ # @!attribute [rw] created_at
2436
+ # The timestamp value of when the over-the-air (OTA) task
2437
+ # configuration was created at.
2438
+ # @return [Time]
2439
+ #
2440
+ class OtaTaskConfigurationSummary < Struct.new(
2441
+ :task_configuration_id,
2442
+ :name,
2443
+ :created_at)
2444
+ SENSITIVE = [:name]
2445
+ include Aws::Structure
2446
+ end
2447
+
2448
+ # Over-the-air (OTA) task retry config.
2449
+ #
2450
+ # @!attribute [rw] retry_config_criteria
2451
+ # The list of retry config criteria.
2452
+ # @return [Array<Types::RetryConfigCriteria>]
2453
+ #
2454
+ class OtaTaskExecutionRetryConfig < Struct.new(
2455
+ :retry_config_criteria)
2456
+ SENSITIVE = []
2457
+ include Aws::Structure
2458
+ end
2459
+
2460
+ # Over-the-air (OTA) task rollout config.
2461
+ #
2462
+ # @!attribute [rw] exponential_rollout_rate
2463
+ # Structure representing exponential rate of rollout for an
2464
+ # over-the-air (OTA) task.
2465
+ # @return [Types::ExponentialRolloutRate]
2466
+ #
2467
+ # @!attribute [rw] maximum_per_minute
2468
+ # The maximum number of things that will be notified of a pending
2469
+ # task, per minute.
2470
+ # @return [Integer]
2471
+ #
2472
+ class OtaTaskExecutionRolloutConfig < Struct.new(
2473
+ :exponential_rollout_rate,
2474
+ :maximum_per_minute)
2475
+ SENSITIVE = []
2476
+ include Aws::Structure
2477
+ end
2478
+
2479
+ # Structure representing one execution summary.
2480
+ #
2481
+ # @!attribute [rw] task_execution_summary
2482
+ # Structure representing one over-the-air (OTA) task execution summary
2483
+ # @return [Types::OtaTaskExecutionSummary]
2484
+ #
2485
+ # @!attribute [rw] managed_thing_id
2486
+ # The id of a managed thing.
2487
+ # @return [String]
2488
+ #
2489
+ class OtaTaskExecutionSummaries < Struct.new(
2490
+ :task_execution_summary,
2491
+ :managed_thing_id)
2492
+ SENSITIVE = []
2493
+ include Aws::Structure
2494
+ end
2495
+
2496
+ # Structure representing one over-the-air (OTA) task execution summary.
2497
+ #
2498
+ # @!attribute [rw] execution_number
2499
+ # The execution number of the over-the-air (OTA) task execution
2500
+ # summary.
2501
+ # @return [Integer]
2502
+ #
2503
+ # @!attribute [rw] last_updated_at
2504
+ # The timestamp value of when the over-the-air (OTA) task execution
2505
+ # summary was last updated.
2506
+ # @return [Time]
2507
+ #
2508
+ # @!attribute [rw] queued_at
2509
+ # The timestamp value of when the over-the-air (OTA) task execution
2510
+ # summary is targeted to start.
2511
+ # @return [Time]
2512
+ #
2513
+ # @!attribute [rw] retry_attempt
2514
+ # The number of retry attempts for starting the over-the-air (OTA)
2515
+ # task execution summary after a failed attempt.
2516
+ # @return [Integer]
2517
+ #
2518
+ # @!attribute [rw] started_at
2519
+ # The timestamp value of when the over-the-air (OTA) task execution
2520
+ # summary started.
2521
+ # @return [Time]
2522
+ #
2523
+ # @!attribute [rw] status
2524
+ # The status of the over-the-air (OTA) task execution summary.
2525
+ # @return [String]
2526
+ #
2527
+ class OtaTaskExecutionSummary < Struct.new(
2528
+ :execution_number,
2529
+ :last_updated_at,
2530
+ :queued_at,
2531
+ :retry_attempt,
2532
+ :started_at,
2533
+ :status)
2534
+ SENSITIVE = []
2535
+ include Aws::Structure
2536
+ end
2537
+
2538
+ # Over-the-air (OTA) task scheduling config.
2539
+ #
2540
+ # @!attribute [rw] end_behavior
2541
+ # Specifies the end behavior for all task executions after a task
2542
+ # reaches the selected `endTime`. If `endTime` is not selected when
2543
+ # creating the task, then `endBehavior` does not apply.
2544
+ # @return [String]
2545
+ #
2546
+ # @!attribute [rw] end_time
2547
+ # The time an over-the-air (OTA) task will stop.
2548
+ # @return [String]
2549
+ #
2550
+ # @!attribute [rw] maintenance_windows
2551
+ # Maintenance window list for over-the-air (OTA) task scheduling
2552
+ # config.
2553
+ # @return [Array<Types::ScheduleMaintenanceWindow>]
2554
+ #
2555
+ # @!attribute [rw] start_time
2556
+ # The time an over-the-air (OTA) task will start.
2557
+ # @return [String]
2558
+ #
2559
+ class OtaTaskSchedulingConfig < Struct.new(
2560
+ :end_behavior,
2561
+ :end_time,
2562
+ :maintenance_windows,
2563
+ :start_time)
2564
+ SENSITIVE = []
2565
+ include Aws::Structure
2566
+ end
2567
+
2568
+ # Structure representing one over-the-air (OTA) task.
2569
+ #
2570
+ # @!attribute [rw] task_id
2571
+ # The id of the over-the-air (OTA) task.
2572
+ # @return [String]
2573
+ #
2574
+ # @!attribute [rw] task_arn
2575
+ # The Amazon Resource Name (ARN) of the over-the-air (OTA) task.
2576
+ # @return [String]
2577
+ #
2578
+ # @!attribute [rw] created_at
2579
+ # The timestamp value of when the over-the-air (OTA) task was created
2580
+ # at.
2581
+ # @return [Time]
2582
+ #
2583
+ # @!attribute [rw] last_updated_at
2584
+ # The timestamp value of when the over-the-air (OTA) task was last
2585
+ # updated at.
2586
+ # @return [Time]
2587
+ #
2588
+ # @!attribute [rw] task_configuration_id
2589
+ # The identifier for the over-the-air (OTA) task configuration.
2590
+ # @return [String]
2591
+ #
2592
+ # @!attribute [rw] status
2593
+ # The status of the over-the-air (OTA) task summary.
2594
+ # @return [String]
2595
+ #
2596
+ class OtaTaskSummary < Struct.new(
2597
+ :task_id,
2598
+ :task_arn,
2599
+ :created_at,
2600
+ :last_updated_at,
2601
+ :task_configuration_id,
2602
+ :status)
2603
+ SENSITIVE = []
2604
+ include Aws::Structure
2605
+ end
2606
+
2607
+ # Over-the-air (OTA) task timeout config.
2608
+ #
2609
+ # @!attribute [rw] in_progress_timeout_in_minutes
2610
+ # Specifies the amount of time the device has to finish execution of
2611
+ # this task. The timeout interval can be anywhere between 1 minute and
2612
+ # 7 days.
2613
+ # @return [Integer]
2614
+ #
2615
+ class OtaTaskTimeoutConfig < Struct.new(
2616
+ :in_progress_timeout_in_minutes)
2617
+ SENSITIVE = []
2618
+ include Aws::Structure
2619
+ end
2620
+
2621
+ # Structure describing a provisioning profile.
2622
+ #
2623
+ # @!attribute [rw] name
2624
+ # The name of the provisioning template.
2625
+ # @return [String]
2626
+ #
2627
+ # @!attribute [rw] id
2628
+ # The identifier of the provisioning profile.
2629
+ # @return [String]
2630
+ #
2631
+ # @!attribute [rw] arn
2632
+ # The Amazon Resource Name (ARN) of the provisioning template used in
2633
+ # the provisioning profile.
2634
+ # @return [String]
2635
+ #
2636
+ # @!attribute [rw] provisioning_type
2637
+ # The type of provisioning workflow the device uses for onboarding to
2638
+ # IoT managed integrations.
2639
+ # @return [String]
2640
+ #
2641
+ class ProvisioningProfileSummary < Struct.new(
2642
+ :name,
2643
+ :id,
2644
+ :arn,
2645
+ :provisioning_type)
2646
+ SENSITIVE = []
2647
+ include Aws::Structure
2648
+ end
2649
+
2650
+ # Structure representing a push config.
2651
+ #
2652
+ # @!attribute [rw] abort_config
2653
+ # Structure representing one abort config.
2654
+ # @return [Types::OtaTaskAbortConfig]
2655
+ #
2656
+ # @!attribute [rw] rollout_config
2657
+ # Structure representing one rollout config.
2658
+ # @return [Types::OtaTaskExecutionRolloutConfig]
2659
+ #
2660
+ # @!attribute [rw] timeout_config
2661
+ # Structure representing one timeout config.
2662
+ # @return [Types::OtaTaskTimeoutConfig]
2663
+ #
2664
+ class PushConfig < Struct.new(
2665
+ :abort_config,
2666
+ :rollout_config,
2667
+ :timeout_config)
2668
+ SENSITIVE = []
2669
+ include Aws::Structure
2670
+ end
2671
+
2672
+ # @!attribute [rw] encryption_type
2673
+ # The type of encryption used for the encryption configuration.
2674
+ # @return [String]
2675
+ #
2676
+ # @!attribute [rw] kms_key_arn
2677
+ # The Key Amazon Resource Name (ARN) of the AWS KMS key used for KMS
2678
+ # encryption if you use `KMS_BASED_ENCRYPTION`.
2679
+ # @return [String]
2680
+ #
2681
+ class PutDefaultEncryptionConfigurationRequest < Struct.new(
2682
+ :encryption_type,
2683
+ :kms_key_arn)
2684
+ SENSITIVE = []
2685
+ include Aws::Structure
2686
+ end
2687
+
2688
+ # @!attribute [rw] configuration_status
2689
+ # Provides the status of the default encryption configuration for an
2690
+ # Amazon Web Services account.
2691
+ # @return [Types::ConfigurationStatus]
2692
+ #
2693
+ # @!attribute [rw] encryption_type
2694
+ # The type of encryption used for the encryption configuration.
2695
+ # @return [String]
2696
+ #
2697
+ # @!attribute [rw] kms_key_arn
2698
+ # The Key Amazon Resource Name (ARN) of the AWS KMS key used for KMS
2699
+ # encryption if you use `KMS_BASED_ENCRYPTION`.
2700
+ # @return [String]
2701
+ #
2702
+ class PutDefaultEncryptionConfigurationResponse < Struct.new(
2703
+ :configuration_status,
2704
+ :encryption_type,
2705
+ :kms_key_arn)
2706
+ SENSITIVE = []
2707
+ include Aws::Structure
2708
+ end
2709
+
2710
+ # @!attribute [rw] hub_token_timer_expiry_setting_in_seconds
2711
+ # A user-defined integer value that represents the hub token timer
2712
+ # expiry setting in seconds.
2713
+ # @return [Integer]
2714
+ #
2715
+ class PutHubConfigurationRequest < Struct.new(
2716
+ :hub_token_timer_expiry_setting_in_seconds)
2717
+ SENSITIVE = []
2718
+ include Aws::Structure
2719
+ end
2720
+
2721
+ # @!attribute [rw] hub_token_timer_expiry_setting_in_seconds
2722
+ # A user-defined integer value that represents the hub token timer
2723
+ # expiry setting in seconds.
2724
+ # @return [Integer]
2725
+ #
2726
+ class PutHubConfigurationResponse < Struct.new(
2727
+ :hub_token_timer_expiry_setting_in_seconds)
2728
+ SENSITIVE = []
2729
+ include Aws::Structure
2730
+ end
2731
+
2732
+ # @!attribute [rw] managed_thing_id
2733
+ # The id for a managed thing.
2734
+ # @return [String]
2735
+ #
2736
+ # @!attribute [rw] runtime_log_configurations
2737
+ # The runtime log configuration for a managed thing.
2738
+ # @return [Types::RuntimeLogConfigurations]
2739
+ #
2740
+ class PutRuntimeLogConfigurationRequest < Struct.new(
2741
+ :managed_thing_id,
2742
+ :runtime_log_configurations)
2743
+ SENSITIVE = []
2744
+ include Aws::Structure
2745
+ end
2746
+
2747
+ # @api private
2748
+ #
2749
+ class RegisterCustomEndpointRequest < Aws::EmptyStructure; end
2750
+
2751
+ # @!attribute [rw] endpoint_address
2752
+ # The IoT managed integrations dedicated, custom endpoint for the
2753
+ # device to route traffic through.
2754
+ # @return [String]
2755
+ #
2756
+ class RegisterCustomEndpointResponse < Struct.new(
2757
+ :endpoint_address)
2758
+ SENSITIVE = []
2759
+ include Aws::Structure
2760
+ end
2761
+
2762
+ # @!attribute [rw] managed_thing_id
2763
+ # The id of a managed thing.
2764
+ # @return [String]
2765
+ #
2766
+ class ResetRuntimeLogConfigurationRequest < Struct.new(
2767
+ :managed_thing_id)
2768
+ SENSITIVE = []
2769
+ include Aws::Structure
2770
+ end
2771
+
2772
+ # The specified resource does not exist.
2773
+ #
2774
+ # @!attribute [rw] message
2775
+ # @return [String]
2776
+ #
2777
+ class ResourceNotFoundException < Struct.new(
2778
+ :message)
2779
+ SENSITIVE = []
2780
+ include Aws::Structure
2781
+ end
2782
+
2783
+ # Structure representing one retry config criteria.
2784
+ #
2785
+ # @!attribute [rw] failure_type
2786
+ # Over-the-air (OTA) retry criteria failure type.
2787
+ # @return [String]
2788
+ #
2789
+ # @!attribute [rw] min_number_of_retries
2790
+ # The number of retries allowed for a failure type for the
2791
+ # over-the-air (OTA) task.
2792
+ # @return [Integer]
2793
+ #
2794
+ class RetryConfigCriteria < Struct.new(
2795
+ :failure_type,
2796
+ :min_number_of_retries)
2797
+ SENSITIVE = []
2798
+ include Aws::Structure
2799
+ end
2800
+
2801
+ # Structure representing rollout config criteria.
2802
+ #
2803
+ # @!attribute [rw] number_of_notified_things
2804
+ # The threshold for number of notified things that will initiate the
2805
+ # increase in rate of rollout.
2806
+ # @return [Integer]
2807
+ #
2808
+ # @!attribute [rw] number_of_succeeded_things
2809
+ # The threshold for number of succeeded things that will initiate the
2810
+ # increase in rate of rollout.
2811
+ # @return [Integer]
2812
+ #
2813
+ class RolloutRateIncreaseCriteria < Struct.new(
2814
+ :number_of_notified_things,
2815
+ :number_of_succeeded_things)
2816
+ SENSITIVE = []
2817
+ include Aws::Structure
2818
+ end
2819
+
2820
+ # The different configurations for runtime logs.
2821
+ #
2822
+ # @!attribute [rw] log_level
2823
+ # The different log levels available for configuration.
2824
+ # @return [String]
2825
+ #
2826
+ # @!attribute [rw] log_flush_level
2827
+ # The different log levels available for configuration.
2828
+ # @return [String]
2829
+ #
2830
+ # @!attribute [rw] local_store_location
2831
+ # Configuration of where to store runtime logs in the device.
2832
+ # @return [String]
2833
+ #
2834
+ # @!attribute [rw] local_store_file_rotation_max_files
2835
+ # Configuration to set the maximum number of runtime log files that
2836
+ # can be stored on the device before the oldest files are deleted or
2837
+ # overwritten.
2838
+ # @return [Integer]
2839
+ #
2840
+ # @!attribute [rw] local_store_file_rotation_max_bytes
2841
+ # Configuration to set the maximum bytes of runtime logs that can be
2842
+ # stored on the device before the oldest logs are deleted or
2843
+ # overwritten.
2844
+ # @return [Integer]
2845
+ #
2846
+ # @!attribute [rw] upload_log
2847
+ # Configuration to enable or disable uploading of runtime logs to the
2848
+ # cloud.
2849
+ # @return [Boolean]
2850
+ #
2851
+ # @!attribute [rw] upload_period_minutes
2852
+ # Configuration to set the time interval in minutes between each batch
2853
+ # of runtime logs that the device uploads to the cloud.
2854
+ # @return [Integer]
2855
+ #
2856
+ # @!attribute [rw] delete_local_store_after_upload
2857
+ # Configuration to enable or disable deleting of runtime logs in the
2858
+ # device once uploaded to the cloud.
2859
+ # @return [Boolean]
2860
+ #
2861
+ class RuntimeLogConfigurations < Struct.new(
2862
+ :log_level,
2863
+ :log_flush_level,
2864
+ :local_store_location,
2865
+ :local_store_file_rotation_max_files,
2866
+ :local_store_file_rotation_max_bytes,
2867
+ :upload_log,
2868
+ :upload_period_minutes,
2869
+ :delete_local_store_after_upload)
2870
+ SENSITIVE = []
2871
+ include Aws::Structure
2872
+ end
2873
+
2874
+ # Structure representing scheduling maintenance window.
2875
+ #
2876
+ # @!attribute [rw] duration_in_minutes
2877
+ # Displays the duration of the next maintenance window.
2878
+ # @return [Integer]
2879
+ #
2880
+ # @!attribute [rw] start_time
2881
+ # Displays the start time of the next maintenance window.
2882
+ # @return [String]
2883
+ #
2884
+ class ScheduleMaintenanceWindow < Struct.new(
2885
+ :duration_in_minutes,
2886
+ :start_time)
2887
+ SENSITIVE = []
2888
+ include Aws::Structure
2889
+ end
2890
+
2891
+ # List item describing a schema version.
2892
+ #
2893
+ # @!attribute [rw] schema_id
2894
+ # The identifier of the schema version.
2895
+ # @return [String]
2896
+ #
2897
+ # @!attribute [rw] type
2898
+ # The type of schema version.
2899
+ # @return [String]
2900
+ #
2901
+ # @!attribute [rw] description
2902
+ # A description of the schema version.
2903
+ # @return [String]
2904
+ #
2905
+ # @!attribute [rw] namespace
2906
+ # The name of the schema version.
2907
+ # @return [String]
2908
+ #
2909
+ # @!attribute [rw] semantic_version
2910
+ # The schema version. If this is left blank, it defaults to the latest
2911
+ # version.
2912
+ # @return [String]
2913
+ #
2914
+ # @!attribute [rw] visibility
2915
+ # The visibility of the schema version.
2916
+ # @return [String]
2917
+ #
2918
+ class SchemaVersionListItem < Struct.new(
2919
+ :schema_id,
2920
+ :type,
2921
+ :description,
2922
+ :namespace,
2923
+ :semantic_version,
2924
+ :visibility)
2925
+ SENSITIVE = []
2926
+ include Aws::Structure
2927
+ end
2928
+
2929
+ # @!attribute [rw] managed_thing_id
2930
+ # The id of the device.
2931
+ # @return [String]
2932
+ #
2933
+ # @!attribute [rw] endpoints
2934
+ # The device endpoint.
2935
+ # @return [Array<Types::CommandEndpoint>]
2936
+ #
2937
+ # @!attribute [rw] connector_association_id
2938
+ # The ID tracking the current discovery process for one connector
2939
+ # association.
2940
+ # @return [String]
2941
+ #
2942
+ class SendManagedThingCommandRequest < Struct.new(
2943
+ :managed_thing_id,
2944
+ :endpoints,
2945
+ :connector_association_id)
2946
+ SENSITIVE = []
2947
+ include Aws::Structure
2948
+ end
2949
+
2950
+ # @!attribute [rw] trace_id
2951
+ # The trace request identifier. This is specified by the device owner,
2952
+ # but will be generated by IoT managed integrations if not provided by
2953
+ # the device owner.
2954
+ # @return [String]
2955
+ #
2956
+ class SendManagedThingCommandResponse < Struct.new(
2957
+ :trace_id)
2958
+ SENSITIVE = []
2959
+ include Aws::Structure
2960
+ end
2961
+
2962
+ # The service quota has been exceeded for this request.
2963
+ #
2964
+ # @!attribute [rw] message
2965
+ # @return [String]
2966
+ #
2967
+ class ServiceQuotaExceededException < Struct.new(
2968
+ :message)
2969
+ SENSITIVE = []
2970
+ include Aws::Structure
2971
+ end
2972
+
2973
+ # The service is temporarily unavailable.
2974
+ #
2975
+ # @!attribute [rw] message
2976
+ # @return [String]
2977
+ #
2978
+ class ServiceUnavailableException < Struct.new(
2979
+ :message)
2980
+ SENSITIVE = []
2981
+ include Aws::Structure
2982
+ end
2983
+
2984
+ # @!attribute [rw] discovery_type
2985
+ # The discovery type supporting the type of device to be discovered in
2986
+ # the device discovery job request.
2987
+ # @return [String]
2988
+ #
2989
+ # @!attribute [rw] controller_identifier
2990
+ # The id of the end-user's IoT hub.
2991
+ # @return [String]
2992
+ #
2993
+ # @!attribute [rw] connector_association_identifier
2994
+ # The id of the connector association.
2995
+ # @return [String]
2996
+ #
2997
+ # @!attribute [rw] authentication_material
2998
+ # The authentication material required to start the local device
2999
+ # discovery job request.
3000
+ # @return [String]
3001
+ #
3002
+ # @!attribute [rw] authentication_material_type
3003
+ # The type of authentication material used for device discovery jobs.
3004
+ # @return [String]
3005
+ #
3006
+ # @!attribute [rw] client_token
3007
+ # An idempotency token. If you retry a request that completed
3008
+ # successfully initially using the same client token and parameters,
3009
+ # then the retry attempt will succeed without performing any further
3010
+ # actions.
3011
+ # @return [String]
3012
+ #
3013
+ # @!attribute [rw] tags
3014
+ # A set of key/value pairs that are used to manage the device
3015
+ # discovery request.
3016
+ # @return [Hash<String,String>]
3017
+ #
3018
+ class StartDeviceDiscoveryRequest < Struct.new(
3019
+ :discovery_type,
3020
+ :controller_identifier,
3021
+ :connector_association_identifier,
3022
+ :authentication_material,
3023
+ :authentication_material_type,
3024
+ :client_token,
3025
+ :tags)
3026
+ SENSITIVE = [:authentication_material, :tags]
3027
+ include Aws::Structure
3028
+ end
3029
+
3030
+ # @!attribute [rw] id
3031
+ # The id of the device discovery job request.
3032
+ # @return [String]
3033
+ #
3034
+ # @!attribute [rw] started_at
3035
+ # The timestamp value for the start time of the device discovery.
3036
+ # @return [Time]
3037
+ #
3038
+ class StartDeviceDiscoveryResponse < Struct.new(
3039
+ :id,
3040
+ :started_at)
3041
+ SENSITIVE = []
3042
+ include Aws::Structure
3043
+ end
3044
+
3045
+ # State capabilities added for the managed thing.
3046
+ #
3047
+ # @!attribute [rw] id
3048
+ # The id of the managed thing in the capability report.
3049
+ # @return [String]
3050
+ #
3051
+ # @!attribute [rw] name
3052
+ # Name for the Amazon Web Services capability.
3053
+ # @return [String]
3054
+ #
3055
+ # @!attribute [rw] version
3056
+ # Version for the Amazon Web Services capability.
3057
+ # @return [String]
3058
+ #
3059
+ # @!attribute [rw] properties
3060
+ # Describe the command capability with the properties it supports.
3061
+ # @return [Hash,Array,String,Numeric,Boolean]
3062
+ #
3063
+ class StateCapability < Struct.new(
3064
+ :id,
3065
+ :name,
3066
+ :version,
3067
+ :properties)
3068
+ SENSITIVE = [:properties]
3069
+ include Aws::Structure
3070
+ end
3071
+
3072
+ # Describe the endpoint with an Id, a name, and the relevant
3073
+ # capabilities for reporting state
3074
+ #
3075
+ # @!attribute [rw] endpoint_id
3076
+ # Numeric identifier of the endpoint
3077
+ # @return [String]
3078
+ #
3079
+ # @!attribute [rw] capabilities
3080
+ # Describe the endpoint with an id, a name, and the relevant
3081
+ # capabilities for the reporting state.
3082
+ # @return [Array<Types::StateCapability>]
3083
+ #
3084
+ class StateEndpoint < Struct.new(
3085
+ :endpoint_id,
3086
+ :capabilities)
3087
+ SENSITIVE = []
3088
+ include Aws::Structure
3089
+ end
3090
+
3091
+ # Details about the over-the-air (OTA) task process.
3092
+ #
3093
+ # @!attribute [rw] number_of_canceled_things
3094
+ # The number of canceled things in an over-the-air (OTA) task.
3095
+ # @return [Integer]
3096
+ #
3097
+ # @!attribute [rw] number_of_failed_things
3098
+ # The number of failed things in an over-the-air (OTA) task.
3099
+ # @return [Integer]
3100
+ #
3101
+ # @!attribute [rw] number_of_in_progress_things
3102
+ # The number of in progress things in an over-the-air (OTA) task.
3103
+ # @return [Integer]
3104
+ #
3105
+ # @!attribute [rw] number_of_queued_things
3106
+ # The number of queued things in an over-the-air (OTA) task.
3107
+ # @return [Integer]
3108
+ #
3109
+ # @!attribute [rw] number_of_rejected_things
3110
+ # The number of rejected things in an over-the-air (OTA) task.
3111
+ # @return [Integer]
3112
+ #
3113
+ # @!attribute [rw] number_of_removed_things
3114
+ # The number of removed things in an over-the-air (OTA) task.
3115
+ # @return [Integer]
3116
+ #
3117
+ # @!attribute [rw] number_of_succeeded_things
3118
+ # The number of succeeded things in an over-the-air (OTA) task.
3119
+ # @return [Integer]
3120
+ #
3121
+ # @!attribute [rw] number_of_timed_out_things
3122
+ # The number of timed out things in an over-the-air (OTA) task.
3123
+ # @return [Integer]
3124
+ #
3125
+ # @!attribute [rw] processing_targets
3126
+ # The targets of the over-the-air (OTA) task.
3127
+ # @return [Array<String>]
3128
+ #
3129
+ class TaskProcessingDetails < Struct.new(
3130
+ :number_of_canceled_things,
3131
+ :number_of_failed_things,
3132
+ :number_of_in_progress_things,
3133
+ :number_of_queued_things,
3134
+ :number_of_rejected_things,
3135
+ :number_of_removed_things,
3136
+ :number_of_succeeded_things,
3137
+ :number_of_timed_out_things,
3138
+ :processing_targets)
3139
+ SENSITIVE = []
3140
+ include Aws::Structure
3141
+ end
3142
+
3143
+ # The rate exceeds the limit.
3144
+ #
3145
+ # @!attribute [rw] message
3146
+ # @return [String]
3147
+ #
3148
+ class ThrottlingException < Struct.new(
3149
+ :message)
3150
+ SENSITIVE = []
3151
+ include Aws::Structure
3152
+ end
3153
+
3154
+ # You are not authorized to perform this operation.
3155
+ #
3156
+ # @!attribute [rw] message
3157
+ # @return [String]
3158
+ #
3159
+ class UnauthorizedException < Struct.new(
3160
+ :message)
3161
+ SENSITIVE = []
3162
+ include Aws::Structure
3163
+ end
3164
+
3165
+ # @!attribute [rw] name
3166
+ # The name of the customer-managed destination.
3167
+ # @return [String]
3168
+ #
3169
+ # @!attribute [rw] delivery_destination_arn
3170
+ # The Amazon Resource Name (ARN) of the customer-managed destination.
3171
+ # @return [String]
3172
+ #
3173
+ # @!attribute [rw] delivery_destination_type
3174
+ # The destination type for the customer-managed destination.
3175
+ # @return [String]
3176
+ #
3177
+ # @!attribute [rw] role_arn
3178
+ # The Amazon Resource Name (ARN) of the delivery destination role.
3179
+ # @return [String]
3180
+ #
3181
+ # @!attribute [rw] description
3182
+ # The description of the customer-managed destination.
3183
+ # @return [String]
3184
+ #
3185
+ class UpdateDestinationRequest < Struct.new(
3186
+ :name,
3187
+ :delivery_destination_arn,
3188
+ :delivery_destination_type,
3189
+ :role_arn,
3190
+ :description)
3191
+ SENSITIVE = []
3192
+ include Aws::Structure
3193
+ end
3194
+
3195
+ # @!attribute [rw] id
3196
+ # The log configuration id.
3197
+ # @return [String]
3198
+ #
3199
+ # @!attribute [rw] event_log_level
3200
+ # The log level for the event in terms of severity.
3201
+ # @return [String]
3202
+ #
3203
+ class UpdateEventLogConfigurationRequest < Struct.new(
3204
+ :id,
3205
+ :event_log_level)
3206
+ SENSITIVE = []
3207
+ include Aws::Structure
3208
+ end
3209
+
3210
+ # @!attribute [rw] identifier
3211
+ # The id of the managed thing.
3212
+ # @return [String]
3213
+ #
3214
+ # @!attribute [rw] owner
3215
+ # Owner of the device, usually an indication of whom the device
3216
+ # belongs to. This value should not contain personal identifiable
3217
+ # information.
3218
+ # @return [String]
3219
+ #
3220
+ # @!attribute [rw] credential_locker_id
3221
+ # The identifier of the credential for the managed thing.
3222
+ # @return [String]
3223
+ #
3224
+ # @!attribute [rw] serial_number
3225
+ # The serial number of the device.
3226
+ # @return [String]
3227
+ #
3228
+ # @!attribute [rw] brand
3229
+ # The brand of the device.
3230
+ # @return [String]
3231
+ #
3232
+ # @!attribute [rw] model
3233
+ # The model of the device.
3234
+ # @return [String]
3235
+ #
3236
+ # @!attribute [rw] name
3237
+ # The name of the managed thing representing the physical device.
3238
+ # @return [String]
3239
+ #
3240
+ # @!attribute [rw] capability_report
3241
+ # A report of the capabilities for the managed thing.
3242
+ # @return [Types::CapabilityReport]
3243
+ #
3244
+ # @!attribute [rw] capabilities
3245
+ # The capabilities of the device such as light bulb.
3246
+ # @return [String]
3247
+ #
3248
+ # @!attribute [rw] classification
3249
+ # The classification of the managed thing such as light bulb or
3250
+ # thermostat.
3251
+ # @return [String]
3252
+ #
3253
+ # @!attribute [rw] hub_network_mode
3254
+ # The network mode for the hub-connected device.
3255
+ # @return [String]
3256
+ #
3257
+ # @!attribute [rw] meta_data
3258
+ # The metadata for the managed thing.
3259
+ # @return [Hash<String,String>]
3260
+ #
3261
+ class UpdateManagedThingRequest < Struct.new(
3262
+ :identifier,
3263
+ :owner,
3264
+ :credential_locker_id,
3265
+ :serial_number,
3266
+ :brand,
3267
+ :model,
3268
+ :name,
3269
+ :capability_report,
3270
+ :capabilities,
3271
+ :classification,
3272
+ :hub_network_mode,
3273
+ :meta_data)
3274
+ SENSITIVE = [:owner, :serial_number, :brand, :model, :classification]
3275
+ include Aws::Structure
3276
+ end
3277
+
3278
+ # @!attribute [rw] event_type
3279
+ # The type of event triggering a device notification to the
3280
+ # customer-managed destination.
3281
+ # @return [String]
3282
+ #
3283
+ # @!attribute [rw] destination_name
3284
+ # The name of the destination for the notification configuration.
3285
+ # @return [String]
3286
+ #
3287
+ class UpdateNotificationConfigurationRequest < Struct.new(
3288
+ :event_type,
3289
+ :destination_name)
3290
+ SENSITIVE = []
3291
+ include Aws::Structure
3292
+ end
3293
+
3294
+ # @!attribute [rw] identifier
3295
+ # The over-the-air (OTA) task id.
3296
+ # @return [String]
3297
+ #
3298
+ # @!attribute [rw] description
3299
+ # The description of the over-the-air (OTA) task.
3300
+ # @return [String]
3301
+ #
3302
+ # @!attribute [rw] task_configuration_id
3303
+ # The identifier for the over-the-air (OTA) task configuration.
3304
+ # @return [String]
3305
+ #
3306
+ class UpdateOtaTaskRequest < Struct.new(
3307
+ :identifier,
3308
+ :description,
3309
+ :task_configuration_id)
3310
+ SENSITIVE = []
3311
+ include Aws::Structure
3312
+ end
3313
+
3314
+ # A validation error occurred when performing the API request.
3315
+ #
3316
+ # @!attribute [rw] message
3317
+ # @return [String]
3318
+ #
3319
+ class ValidationException < Struct.new(
3320
+ :message)
3321
+ SENSITIVE = []
3322
+ include Aws::Structure
3323
+ end
3324
+
3325
+ end
3326
+ end
3327
+