aws-sdk-iotsitewise 1.56.0 → 1.58.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-iotsitewise/client.rb +1610 -143
- data/lib/aws-sdk-iotsitewise/client_api.rb +611 -40
- data/lib/aws-sdk-iotsitewise/endpoint_provider.rb +1 -1
- data/lib/aws-sdk-iotsitewise/endpoints.rb +154 -0
- data/lib/aws-sdk-iotsitewise/errors.rb +48 -0
- data/lib/aws-sdk-iotsitewise/plugins/endpoints.rb +22 -0
- data/lib/aws-sdk-iotsitewise/types.rb +2109 -239
- data/lib/aws-sdk-iotsitewise.rb +1 -1
- metadata +5 -5
@@ -10,6 +10,17 @@
|
|
10
10
|
module Aws::IoTSiteWise
|
11
11
|
module Types
|
12
12
|
|
13
|
+
# Access is denied.
|
14
|
+
#
|
15
|
+
# @!attribute [rw] message
|
16
|
+
# @return [String]
|
17
|
+
#
|
18
|
+
class AccessDeniedException < Struct.new(
|
19
|
+
:message)
|
20
|
+
SENSITIVE = []
|
21
|
+
include Aws::Structure
|
22
|
+
end
|
23
|
+
|
13
24
|
# Contains an access policy that defines an identity's access to an IoT
|
14
25
|
# SiteWise Monitor resource.
|
15
26
|
#
|
@@ -50,6 +61,62 @@ module Aws::IoTSiteWise
|
|
50
61
|
include Aws::Structure
|
51
62
|
end
|
52
63
|
|
64
|
+
# Contains a definition for an action.
|
65
|
+
#
|
66
|
+
# @!attribute [rw] action_definition_id
|
67
|
+
# The ID of the action definition.
|
68
|
+
# @return [String]
|
69
|
+
#
|
70
|
+
# @!attribute [rw] action_name
|
71
|
+
# The name of the action definition.
|
72
|
+
# @return [String]
|
73
|
+
#
|
74
|
+
# @!attribute [rw] action_type
|
75
|
+
# The type of the action definition.
|
76
|
+
# @return [String]
|
77
|
+
#
|
78
|
+
class ActionDefinition < Struct.new(
|
79
|
+
:action_definition_id,
|
80
|
+
:action_name,
|
81
|
+
:action_type)
|
82
|
+
SENSITIVE = []
|
83
|
+
include Aws::Structure
|
84
|
+
end
|
85
|
+
|
86
|
+
# The JSON payload of the action.
|
87
|
+
#
|
88
|
+
# @!attribute [rw] string_value
|
89
|
+
# The payload of the action in a JSON string.
|
90
|
+
# @return [String]
|
91
|
+
#
|
92
|
+
class ActionPayload < Struct.new(
|
93
|
+
:string_value)
|
94
|
+
SENSITIVE = []
|
95
|
+
include Aws::Structure
|
96
|
+
end
|
97
|
+
|
98
|
+
# Contains the summary of the actions.
|
99
|
+
#
|
100
|
+
# @!attribute [rw] action_id
|
101
|
+
# The ID of the action.
|
102
|
+
# @return [String]
|
103
|
+
#
|
104
|
+
# @!attribute [rw] action_definition_id
|
105
|
+
# The ID of the action definition.
|
106
|
+
# @return [String]
|
107
|
+
#
|
108
|
+
# @!attribute [rw] target_resource
|
109
|
+
# The resource the action will be taken on.
|
110
|
+
# @return [Types::TargetResource]
|
111
|
+
#
|
112
|
+
class ActionSummary < Struct.new(
|
113
|
+
:action_id,
|
114
|
+
:action_definition_id,
|
115
|
+
:target_resource)
|
116
|
+
SENSITIVE = []
|
117
|
+
include Aws::Structure
|
118
|
+
end
|
119
|
+
|
53
120
|
# Contains aggregated asset property values (for example, average,
|
54
121
|
# minimum, and maximum).
|
55
122
|
#
|
@@ -176,12 +243,91 @@ module Aws::IoTSiteWise
|
|
176
243
|
# The ID of the asset composite model.
|
177
244
|
# @return [String]
|
178
245
|
#
|
246
|
+
# @!attribute [rw] external_id
|
247
|
+
# The external ID of the asset composite model. For more information,
|
248
|
+
# see [Using external IDs][1] in the *IoT SiteWise User Guide*.
|
249
|
+
#
|
250
|
+
#
|
251
|
+
#
|
252
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
|
253
|
+
# @return [String]
|
254
|
+
#
|
179
255
|
class AssetCompositeModel < Struct.new(
|
180
256
|
:name,
|
181
257
|
:description,
|
182
258
|
:type,
|
183
259
|
:properties,
|
184
|
-
:id
|
260
|
+
:id,
|
261
|
+
:external_id)
|
262
|
+
SENSITIVE = []
|
263
|
+
include Aws::Structure
|
264
|
+
end
|
265
|
+
|
266
|
+
# Represents one level between a composite model and the root of the
|
267
|
+
# asset.
|
268
|
+
#
|
269
|
+
# @!attribute [rw] id
|
270
|
+
# The ID of the path segment.
|
271
|
+
# @return [String]
|
272
|
+
#
|
273
|
+
# @!attribute [rw] name
|
274
|
+
# The name of the path segment.
|
275
|
+
# @return [String]
|
276
|
+
#
|
277
|
+
class AssetCompositeModelPathSegment < Struct.new(
|
278
|
+
:id,
|
279
|
+
:name)
|
280
|
+
SENSITIVE = []
|
281
|
+
include Aws::Structure
|
282
|
+
end
|
283
|
+
|
284
|
+
# Contains a summary of the composite model for a specific asset.
|
285
|
+
#
|
286
|
+
# @!attribute [rw] id
|
287
|
+
# The ID of the composite model that this summary describes.
|
288
|
+
# @return [String]
|
289
|
+
#
|
290
|
+
# @!attribute [rw] external_id
|
291
|
+
# An external ID to assign to the asset model.
|
292
|
+
#
|
293
|
+
# If the composite model is a derived composite model, or one nested
|
294
|
+
# inside a component model, you can only set the external ID using
|
295
|
+
# `UpdateAssetModelCompositeModel` and specifying the derived ID of
|
296
|
+
# the model or property from the created model it's a part of.
|
297
|
+
# @return [String]
|
298
|
+
#
|
299
|
+
# @!attribute [rw] name
|
300
|
+
# The name of the composite model that this summary describes.
|
301
|
+
# @return [String]
|
302
|
+
#
|
303
|
+
# @!attribute [rw] type
|
304
|
+
# The type of asset model.
|
305
|
+
#
|
306
|
+
# * **ASSET\_MODEL** – (default) An asset model that you can use to
|
307
|
+
# create assets. Can't be included as a component in another asset
|
308
|
+
# model.
|
309
|
+
#
|
310
|
+
# * **COMPONENT\_MODEL** – A reusable component that you can include
|
311
|
+
# in the composite models of other asset models. You can't create
|
312
|
+
# assets directly from this type of asset model.
|
313
|
+
# @return [String]
|
314
|
+
#
|
315
|
+
# @!attribute [rw] description
|
316
|
+
# A description of the composite model that this summary describes.
|
317
|
+
# @return [String]
|
318
|
+
#
|
319
|
+
# @!attribute [rw] path
|
320
|
+
# The path that includes all the components of the asset model for the
|
321
|
+
# asset.
|
322
|
+
# @return [Array<Types::AssetCompositeModelPathSegment>]
|
323
|
+
#
|
324
|
+
class AssetCompositeModelSummary < Struct.new(
|
325
|
+
:id,
|
326
|
+
:external_id,
|
327
|
+
:name,
|
328
|
+
:type,
|
329
|
+
:description,
|
330
|
+
:path)
|
185
331
|
SENSITIVE = []
|
186
332
|
include Aws::Structure
|
187
333
|
end
|
@@ -190,7 +336,7 @@ module Aws::IoTSiteWise
|
|
190
336
|
# action.
|
191
337
|
#
|
192
338
|
# @!attribute [rw] asset_id
|
193
|
-
# The ID of the asset.
|
339
|
+
# The ID of the asset, in UUID format.
|
194
340
|
# @return [String]
|
195
341
|
#
|
196
342
|
# @!attribute [rw] code
|
@@ -225,9 +371,22 @@ module Aws::IoTSiteWise
|
|
225
371
|
# [2]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html
|
226
372
|
# @return [String]
|
227
373
|
#
|
374
|
+
# @!attribute [rw] external_id
|
375
|
+
# The external ID of the hierarchy, if it has one. When you update an
|
376
|
+
# asset hierarchy, you may assign an external ID if it doesn't
|
377
|
+
# already have one. You can't change the external ID of an asset
|
378
|
+
# hierarchy that already has one. For more information, see [Using
|
379
|
+
# external IDs][1] in the *IoT SiteWise User Guide*.
|
380
|
+
#
|
381
|
+
#
|
382
|
+
#
|
383
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
|
384
|
+
# @return [String]
|
385
|
+
#
|
228
386
|
class AssetHierarchy < Struct.new(
|
229
387
|
:id,
|
230
|
-
:name
|
388
|
+
:name,
|
389
|
+
:external_id)
|
231
390
|
SENSITIVE = []
|
232
391
|
include Aws::Structure
|
233
392
|
end
|
@@ -275,12 +434,23 @@ module Aws::IoTSiteWise
|
|
275
434
|
# The ID of the asset model composite model.
|
276
435
|
# @return [String]
|
277
436
|
#
|
437
|
+
# @!attribute [rw] external_id
|
438
|
+
# The external ID of the asset model composite model. For more
|
439
|
+
# information, see [Using external IDs][1] in the *IoT SiteWise User
|
440
|
+
# Guide*.
|
441
|
+
#
|
442
|
+
#
|
443
|
+
#
|
444
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
|
445
|
+
# @return [String]
|
446
|
+
#
|
278
447
|
class AssetModelCompositeModel < Struct.new(
|
279
448
|
:name,
|
280
449
|
:description,
|
281
450
|
:type,
|
282
451
|
:properties,
|
283
|
-
:id
|
452
|
+
:id,
|
453
|
+
:external_id)
|
284
454
|
SENSITIVE = []
|
285
455
|
include Aws::Structure
|
286
456
|
end
|
@@ -306,11 +476,103 @@ module Aws::IoTSiteWise
|
|
306
476
|
# The asset property definitions for this composite model.
|
307
477
|
# @return [Array<Types::AssetModelPropertyDefinition>]
|
308
478
|
#
|
479
|
+
# @!attribute [rw] id
|
480
|
+
# The ID to assign to the composite model, if desired. IoT SiteWise
|
481
|
+
# automatically generates a unique ID for you, so this parameter is
|
482
|
+
# never required. However, if you prefer to supply your own ID
|
483
|
+
# instead, you can specify it here in UUID format. If you specify your
|
484
|
+
# own ID, it must be globally unique.
|
485
|
+
# @return [String]
|
486
|
+
#
|
487
|
+
# @!attribute [rw] external_id
|
488
|
+
# An external ID to assign to the composite model. The external ID
|
489
|
+
# must be unique among composite models within this asset model. For
|
490
|
+
# more information, see [Using external IDs][1] in the *IoT SiteWise
|
491
|
+
# User Guide*.
|
492
|
+
#
|
493
|
+
#
|
494
|
+
#
|
495
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
|
496
|
+
# @return [String]
|
497
|
+
#
|
309
498
|
class AssetModelCompositeModelDefinition < Struct.new(
|
310
499
|
:name,
|
311
500
|
:description,
|
312
501
|
:type,
|
313
|
-
:properties
|
502
|
+
:properties,
|
503
|
+
:id,
|
504
|
+
:external_id)
|
505
|
+
SENSITIVE = []
|
506
|
+
include Aws::Structure
|
507
|
+
end
|
508
|
+
|
509
|
+
# Represents one level between a composite model and the root of the
|
510
|
+
# asset model.
|
511
|
+
#
|
512
|
+
# @!attribute [rw] id
|
513
|
+
# The ID of the path segment.
|
514
|
+
# @return [String]
|
515
|
+
#
|
516
|
+
# @!attribute [rw] name
|
517
|
+
# The name of the path segment.
|
518
|
+
# @return [String]
|
519
|
+
#
|
520
|
+
class AssetModelCompositeModelPathSegment < Struct.new(
|
521
|
+
:id,
|
522
|
+
:name)
|
523
|
+
SENSITIVE = []
|
524
|
+
include Aws::Structure
|
525
|
+
end
|
526
|
+
|
527
|
+
# Contains a summary of the composite model.
|
528
|
+
#
|
529
|
+
# @!attribute [rw] id
|
530
|
+
# The ID of the the composite model that this summary describes..
|
531
|
+
# @return [String]
|
532
|
+
#
|
533
|
+
# @!attribute [rw] external_id
|
534
|
+
# The external ID of a composite model on this asset model. For more
|
535
|
+
# information, see [Using external IDs][1] in the *IoT SiteWise User
|
536
|
+
# Guide*.
|
537
|
+
#
|
538
|
+
#
|
539
|
+
#
|
540
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
|
541
|
+
# @return [String]
|
542
|
+
#
|
543
|
+
# @!attribute [rw] name
|
544
|
+
# The name of the the composite model that this summary describes..
|
545
|
+
# @return [String]
|
546
|
+
#
|
547
|
+
# @!attribute [rw] type
|
548
|
+
# The type of asset model.
|
549
|
+
#
|
550
|
+
# * **ASSET\_MODEL** – (default) An asset model that you can use to
|
551
|
+
# create assets. Can't be included as a component in another asset
|
552
|
+
# model.
|
553
|
+
#
|
554
|
+
# * **COMPONENT\_MODEL** – A reusable component that you can include
|
555
|
+
# in the composite models of other asset models. You can't create
|
556
|
+
# assets directly from this type of asset model.
|
557
|
+
# @return [String]
|
558
|
+
#
|
559
|
+
# @!attribute [rw] description
|
560
|
+
# The description of the the composite model that this summary
|
561
|
+
# describes..
|
562
|
+
# @return [String]
|
563
|
+
#
|
564
|
+
# @!attribute [rw] path
|
565
|
+
# The path that includes all the pieces that make up the composite
|
566
|
+
# model.
|
567
|
+
# @return [Array<Types::AssetModelCompositeModelPathSegment>]
|
568
|
+
#
|
569
|
+
class AssetModelCompositeModelSummary < Struct.new(
|
570
|
+
:id,
|
571
|
+
:external_id,
|
572
|
+
:name,
|
573
|
+
:type,
|
574
|
+
:description,
|
575
|
+
:path)
|
314
576
|
SENSITIVE = []
|
315
577
|
include Aws::Structure
|
316
578
|
end
|
@@ -321,6 +583,24 @@ module Aws::IoTSiteWise
|
|
321
583
|
#
|
322
584
|
# @!attribute [rw] id
|
323
585
|
# The ID of the asset model hierarchy. This ID is a `hierarchyId`.
|
586
|
+
#
|
587
|
+
# * If you are callling [UpdateAssetModel][1] to create a *new*
|
588
|
+
# hierarchy: You can specify its ID here, if desired. IoT SiteWise
|
589
|
+
# automatically generates a unique ID for you, so this parameter is
|
590
|
+
# never required. However, if you prefer to supply your own ID
|
591
|
+
# instead, you can specify it here in UUID format. If you specify
|
592
|
+
# your own ID, it must be globally unique.
|
593
|
+
#
|
594
|
+
# * If you are calling UpdateAssetModel to modify an *existing*
|
595
|
+
# hierarchy: This can be either the actual ID in UUID format, or
|
596
|
+
# else `externalId:` followed by the external ID, if it has one. For
|
597
|
+
# more information, see [Referencing objects with external IDs][2]
|
598
|
+
# in the *IoT SiteWise User Guide*.
|
599
|
+
#
|
600
|
+
#
|
601
|
+
#
|
602
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html
|
603
|
+
# [2]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references
|
324
604
|
# @return [String]
|
325
605
|
#
|
326
606
|
# @!attribute [rw] name
|
@@ -334,14 +614,41 @@ module Aws::IoTSiteWise
|
|
334
614
|
# @return [String]
|
335
615
|
#
|
336
616
|
# @!attribute [rw] child_asset_model_id
|
337
|
-
# The ID of the asset model. All assets in this
|
338
|
-
# instances of the `childAssetModelId` asset model.
|
617
|
+
# The ID of the asset model, in UUID format. All assets in this
|
618
|
+
# hierarchy must be instances of the `childAssetModelId` asset model.
|
619
|
+
# IoT SiteWise will always return the actual asset model ID for this
|
620
|
+
# value. However, when you are specifying this value as part of a call
|
621
|
+
# to [UpdateAssetModel][1], you may provide either the asset model ID
|
622
|
+
# or else `externalId:` followed by the asset model's external ID.
|
623
|
+
# For more information, see [Using external IDs][2] in the *IoT
|
624
|
+
# SiteWise User Guide*.
|
625
|
+
#
|
626
|
+
#
|
627
|
+
#
|
628
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html
|
629
|
+
# [2]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
|
630
|
+
# @return [String]
|
631
|
+
#
|
632
|
+
# @!attribute [rw] external_id
|
633
|
+
# The external ID (if any) provided in the [CreateAssetModel][1] or
|
634
|
+
# [UpdateAssetModel][2] operation. You can assign an external ID by
|
635
|
+
# specifying this value as part of a call to [UpdateAssetModel][2].
|
636
|
+
# However, you can't change the external ID if one is already
|
637
|
+
# assigned. For more information, see [Using external IDs][3] in the
|
638
|
+
# *IoT SiteWise User Guide*.
|
639
|
+
#
|
640
|
+
#
|
641
|
+
#
|
642
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModel.html
|
643
|
+
# [2]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html
|
644
|
+
# [3]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
|
339
645
|
# @return [String]
|
340
646
|
#
|
341
647
|
class AssetModelHierarchy < Struct.new(
|
342
648
|
:id,
|
343
649
|
:name,
|
344
|
-
:child_asset_model_id
|
650
|
+
:child_asset_model_id,
|
651
|
+
:external_id)
|
345
652
|
SENSITIVE = []
|
346
653
|
include Aws::Structure
|
347
654
|
end
|
@@ -361,12 +668,40 @@ module Aws::IoTSiteWise
|
|
361
668
|
# @return [String]
|
362
669
|
#
|
363
670
|
# @!attribute [rw] child_asset_model_id
|
364
|
-
# The ID of an asset model for this hierarchy.
|
671
|
+
# The ID of an asset model for this hierarchy. This can be either the
|
672
|
+
# actual ID in UUID format, or else `externalId:` followed by the
|
673
|
+
# external ID, if it has one. For more information, see [Referencing
|
674
|
+
# objects with external IDs][1] in the *IoT SiteWise User Guide*.
|
675
|
+
#
|
676
|
+
#
|
677
|
+
#
|
678
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references
|
679
|
+
# @return [String]
|
680
|
+
#
|
681
|
+
# @!attribute [rw] id
|
682
|
+
# The ID to assign to the asset model hierarchy, if desired. IoT
|
683
|
+
# SiteWise automatically generates a unique ID for you, so this
|
684
|
+
# parameter is never required. However, if you prefer to supply your
|
685
|
+
# own ID instead, you can specify it here in UUID format. If you
|
686
|
+
# specify your own ID, it must be globally unique.
|
687
|
+
# @return [String]
|
688
|
+
#
|
689
|
+
# @!attribute [rw] external_id
|
690
|
+
# An external ID to assign to the asset model hierarchy. The external
|
691
|
+
# ID must be unique among asset model hierarchies within this asset
|
692
|
+
# model. For more information, see [Using external IDs][1] in the *IoT
|
693
|
+
# SiteWise User Guide*.
|
694
|
+
#
|
695
|
+
#
|
696
|
+
#
|
697
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
|
365
698
|
# @return [String]
|
366
699
|
#
|
367
700
|
class AssetModelHierarchyDefinition < Struct.new(
|
368
701
|
:name,
|
369
|
-
:child_asset_model_id
|
702
|
+
:child_asset_model_id,
|
703
|
+
:id,
|
704
|
+
:external_id)
|
370
705
|
SENSITIVE = []
|
371
706
|
include Aws::Structure
|
372
707
|
end
|
@@ -375,6 +710,24 @@ module Aws::IoTSiteWise
|
|
375
710
|
#
|
376
711
|
# @!attribute [rw] id
|
377
712
|
# The ID of the asset model property.
|
713
|
+
#
|
714
|
+
# * If you are callling [UpdateAssetModel][1] to create a *new*
|
715
|
+
# property: You can specify its ID here, if desired. IoT SiteWise
|
716
|
+
# automatically generates a unique ID for you, so this parameter is
|
717
|
+
# never required. However, if you prefer to supply your own ID
|
718
|
+
# instead, you can specify it here in UUID format. If you specify
|
719
|
+
# your own ID, it must be globally unique.
|
720
|
+
#
|
721
|
+
# * If you are calling UpdateAssetModel to modify an *existing*
|
722
|
+
# property: This can be either the actual ID in UUID format, or else
|
723
|
+
# `externalId:` followed by the external ID, if it has one. For more
|
724
|
+
# information, see [Referencing objects with external IDs][2] in the
|
725
|
+
# *IoT SiteWise User Guide*.
|
726
|
+
#
|
727
|
+
#
|
728
|
+
#
|
729
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html
|
730
|
+
# [2]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references
|
378
731
|
# @return [String]
|
379
732
|
#
|
380
733
|
# @!attribute [rw] name
|
@@ -398,13 +751,35 @@ module Aws::IoTSiteWise
|
|
398
751
|
# The property type (see `PropertyType`).
|
399
752
|
# @return [Types::PropertyType]
|
400
753
|
#
|
754
|
+
# @!attribute [rw] path
|
755
|
+
# The structured path to the property from the root of the asset
|
756
|
+
# model.
|
757
|
+
# @return [Array<Types::AssetModelPropertyPathSegment>]
|
758
|
+
#
|
759
|
+
# @!attribute [rw] external_id
|
760
|
+
# The external ID (if any) provided in the [CreateAssetModel][1] or
|
761
|
+
# [UpdateAssetModel][2] operation. You can assign an external ID by
|
762
|
+
# specifying this value as part of a call to [UpdateAssetModel][2].
|
763
|
+
# However, you can't change the external ID if one is already
|
764
|
+
# assigned. For more information, see [Using external IDs][3] in the
|
765
|
+
# *IoT SiteWise User Guide*.
|
766
|
+
#
|
767
|
+
#
|
768
|
+
#
|
769
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModel.html
|
770
|
+
# [2]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html
|
771
|
+
# [3]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
|
772
|
+
# @return [String]
|
773
|
+
#
|
401
774
|
class AssetModelProperty < Struct.new(
|
402
775
|
:id,
|
403
776
|
:name,
|
404
777
|
:data_type,
|
405
778
|
:data_type_spec,
|
406
779
|
:unit,
|
407
|
-
:type
|
780
|
+
:type,
|
781
|
+
:path,
|
782
|
+
:external_id)
|
408
783
|
SENSITIVE = []
|
409
784
|
include Aws::Structure
|
410
785
|
end
|
@@ -441,12 +816,51 @@ module Aws::IoTSiteWise
|
|
441
816
|
# specify one type in a property definition.
|
442
817
|
# @return [Types::PropertyType]
|
443
818
|
#
|
819
|
+
# @!attribute [rw] id
|
820
|
+
# The ID to assign to the asset model property, if desired. IoT
|
821
|
+
# SiteWise automatically generates a unique ID for you, so this
|
822
|
+
# parameter is never required. However, if you prefer to supply your
|
823
|
+
# own ID instead, you can specify it here in UUID format. If you
|
824
|
+
# specify your own ID, it must be globally unique.
|
825
|
+
# @return [String]
|
826
|
+
#
|
827
|
+
# @!attribute [rw] external_id
|
828
|
+
# An external ID to assign to the property definition. The external ID
|
829
|
+
# must be unique among property definitions within this asset model.
|
830
|
+
# For more information, see [Using external IDs][1] in the *IoT
|
831
|
+
# SiteWise User Guide*.
|
832
|
+
#
|
833
|
+
#
|
834
|
+
#
|
835
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
|
836
|
+
# @return [String]
|
837
|
+
#
|
444
838
|
class AssetModelPropertyDefinition < Struct.new(
|
445
839
|
:name,
|
446
840
|
:data_type,
|
447
841
|
:data_type_spec,
|
448
842
|
:unit,
|
449
|
-
:type
|
843
|
+
:type,
|
844
|
+
:id,
|
845
|
+
:external_id)
|
846
|
+
SENSITIVE = []
|
847
|
+
include Aws::Structure
|
848
|
+
end
|
849
|
+
|
850
|
+
# Represents one level between a property and the root of the asset
|
851
|
+
# model.
|
852
|
+
#
|
853
|
+
# @!attribute [rw] id
|
854
|
+
# The ID of the path segment.
|
855
|
+
# @return [String]
|
856
|
+
#
|
857
|
+
# @!attribute [rw] name
|
858
|
+
# The name of the path segment.
|
859
|
+
# @return [String]
|
860
|
+
#
|
861
|
+
class AssetModelPropertyPathSegment < Struct.new(
|
862
|
+
:id,
|
863
|
+
:name)
|
450
864
|
SENSITIVE = []
|
451
865
|
include Aws::Structure
|
452
866
|
end
|
@@ -484,6 +898,20 @@ module Aws::IoTSiteWise
|
|
484
898
|
# property.
|
485
899
|
# @return [String]
|
486
900
|
#
|
901
|
+
# @!attribute [rw] path
|
902
|
+
# The structured path to the property from the root of the asset
|
903
|
+
# model.
|
904
|
+
# @return [Array<Types::AssetModelPropertyPathSegment>]
|
905
|
+
#
|
906
|
+
# @!attribute [rw] external_id
|
907
|
+
# The external ID of the property. For more information, see [Using
|
908
|
+
# external IDs][1] in the *IoT SiteWise User Guide*.
|
909
|
+
#
|
910
|
+
#
|
911
|
+
#
|
912
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
|
913
|
+
# @return [String]
|
914
|
+
#
|
487
915
|
class AssetModelPropertySummary < Struct.new(
|
488
916
|
:id,
|
489
917
|
:name,
|
@@ -491,7 +919,9 @@ module Aws::IoTSiteWise
|
|
491
919
|
:data_type_spec,
|
492
920
|
:unit,
|
493
921
|
:type,
|
494
|
-
:asset_model_composite_model_id
|
922
|
+
:asset_model_composite_model_id,
|
923
|
+
:path,
|
924
|
+
:external_id)
|
495
925
|
SENSITIVE = []
|
496
926
|
include Aws::Structure
|
497
927
|
end
|
@@ -522,7 +952,7 @@ module Aws::IoTSiteWise
|
|
522
952
|
# Contains a summary of an asset model.
|
523
953
|
#
|
524
954
|
# @!attribute [rw] id
|
525
|
-
# The ID of the asset model (used with IoT SiteWise
|
955
|
+
# The ID of the asset model (used with IoT SiteWise API operations).
|
526
956
|
# @return [String]
|
527
957
|
#
|
528
958
|
# @!attribute [rw] arn
|
@@ -555,6 +985,27 @@ module Aws::IoTSiteWise
|
|
555
985
|
# The current status of the asset model.
|
556
986
|
# @return [Types::AssetModelStatus]
|
557
987
|
#
|
988
|
+
# @!attribute [rw] asset_model_type
|
989
|
+
# The type of asset model.
|
990
|
+
#
|
991
|
+
# * **ASSET\_MODEL** – (default) An asset model that you can use to
|
992
|
+
# create assets. Can't be included as a component in another asset
|
993
|
+
# model.
|
994
|
+
#
|
995
|
+
# * **COMPONENT\_MODEL** – A reusable component that you can include
|
996
|
+
# in the composite models of other asset models. You can't create
|
997
|
+
# assets directly from this type of asset model.
|
998
|
+
# @return [String]
|
999
|
+
#
|
1000
|
+
# @!attribute [rw] external_id
|
1001
|
+
# The external ID of the asset model. For more information, see [Using
|
1002
|
+
# external IDs][1] in the *IoT SiteWise User Guide*.
|
1003
|
+
#
|
1004
|
+
#
|
1005
|
+
#
|
1006
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
|
1007
|
+
# @return [String]
|
1008
|
+
#
|
558
1009
|
class AssetModelSummary < Struct.new(
|
559
1010
|
:id,
|
560
1011
|
:arn,
|
@@ -562,7 +1013,9 @@ module Aws::IoTSiteWise
|
|
562
1013
|
:description,
|
563
1014
|
:creation_date,
|
564
1015
|
:last_update_date,
|
565
|
-
:status
|
1016
|
+
:status,
|
1017
|
+
:asset_model_type,
|
1018
|
+
:external_id)
|
566
1019
|
SENSITIVE = []
|
567
1020
|
include Aws::Structure
|
568
1021
|
end
|
@@ -611,6 +1064,19 @@ module Aws::IoTSiteWise
|
|
611
1064
|
# The unit (such as `Newtons` or `RPM`) of the asset property.
|
612
1065
|
# @return [String]
|
613
1066
|
#
|
1067
|
+
# @!attribute [rw] path
|
1068
|
+
# The structured path to the property from the root of the asset.
|
1069
|
+
# @return [Array<Types::AssetPropertyPathSegment>]
|
1070
|
+
#
|
1071
|
+
# @!attribute [rw] external_id
|
1072
|
+
# The external ID of the asset property. For more information, see
|
1073
|
+
# [Using external IDs][1] in the *IoT SiteWise User Guide*.
|
1074
|
+
#
|
1075
|
+
#
|
1076
|
+
#
|
1077
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
|
1078
|
+
# @return [String]
|
1079
|
+
#
|
614
1080
|
class AssetProperty < Struct.new(
|
615
1081
|
:id,
|
616
1082
|
:name,
|
@@ -618,7 +1084,26 @@ module Aws::IoTSiteWise
|
|
618
1084
|
:notification,
|
619
1085
|
:data_type,
|
620
1086
|
:data_type_spec,
|
621
|
-
:unit
|
1087
|
+
:unit,
|
1088
|
+
:path,
|
1089
|
+
:external_id)
|
1090
|
+
SENSITIVE = []
|
1091
|
+
include Aws::Structure
|
1092
|
+
end
|
1093
|
+
|
1094
|
+
# Represents one level between a property and the root of the asset.
|
1095
|
+
#
|
1096
|
+
# @!attribute [rw] id
|
1097
|
+
# The ID of the path segment.
|
1098
|
+
# @return [String]
|
1099
|
+
#
|
1100
|
+
# @!attribute [rw] name
|
1101
|
+
# The name of the path segment.
|
1102
|
+
# @return [String]
|
1103
|
+
#
|
1104
|
+
class AssetPropertyPathSegment < Struct.new(
|
1105
|
+
:id,
|
1106
|
+
:name)
|
622
1107
|
SENSITIVE = []
|
623
1108
|
include Aws::Structure
|
624
1109
|
end
|
@@ -661,12 +1146,27 @@ module Aws::IoTSiteWise
|
|
661
1146
|
# The ID of the composite model that contains the asset property.
|
662
1147
|
# @return [String]
|
663
1148
|
#
|
1149
|
+
# @!attribute [rw] path
|
1150
|
+
# The structured path to the property from the root of the asset.
|
1151
|
+
# @return [Array<Types::AssetPropertyPathSegment>]
|
1152
|
+
#
|
1153
|
+
# @!attribute [rw] external_id
|
1154
|
+
# The external ID of the property. For more information, see [Using
|
1155
|
+
# external IDs][1] in the *IoT SiteWise User Guide*.
|
1156
|
+
#
|
1157
|
+
#
|
1158
|
+
#
|
1159
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
|
1160
|
+
# @return [String]
|
1161
|
+
#
|
664
1162
|
class AssetPropertySummary < Struct.new(
|
665
1163
|
:id,
|
666
1164
|
:alias,
|
667
1165
|
:unit,
|
668
1166
|
:notification,
|
669
|
-
:asset_composite_model_id
|
1167
|
+
:asset_composite_model_id,
|
1168
|
+
:path,
|
1169
|
+
:external_id)
|
670
1170
|
SENSITIVE = []
|
671
1171
|
include Aws::Structure
|
672
1172
|
end
|
@@ -745,7 +1245,7 @@ module Aws::IoTSiteWise
|
|
745
1245
|
# Contains a summary of an asset.
|
746
1246
|
#
|
747
1247
|
# @!attribute [rw] id
|
748
|
-
# The ID of the asset.
|
1248
|
+
# The ID of the asset, in UUID format.
|
749
1249
|
# @return [String]
|
750
1250
|
#
|
751
1251
|
# @!attribute [rw] arn
|
@@ -787,6 +1287,15 @@ module Aws::IoTSiteWise
|
|
787
1287
|
# A description for the asset.
|
788
1288
|
# @return [String]
|
789
1289
|
#
|
1290
|
+
# @!attribute [rw] external_id
|
1291
|
+
# The external ID of the asset. For more information, see [Using
|
1292
|
+
# external IDs][1] in the *IoT SiteWise User Guide*.
|
1293
|
+
#
|
1294
|
+
#
|
1295
|
+
#
|
1296
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
|
1297
|
+
# @return [String]
|
1298
|
+
#
|
790
1299
|
class AssetSummary < Struct.new(
|
791
1300
|
:id,
|
792
1301
|
:arn,
|
@@ -796,28 +1305,48 @@ module Aws::IoTSiteWise
|
|
796
1305
|
:last_update_date,
|
797
1306
|
:status,
|
798
1307
|
:hierarchies,
|
799
|
-
:description
|
1308
|
+
:description,
|
1309
|
+
:external_id)
|
800
1310
|
SENSITIVE = []
|
801
1311
|
include Aws::Structure
|
802
1312
|
end
|
803
1313
|
|
804
1314
|
# @!attribute [rw] asset_id
|
805
|
-
# The ID of the parent asset.
|
1315
|
+
# The ID of the parent asset. This can be either the actual ID in UUID
|
1316
|
+
# format, or else `externalId:` followed by the external ID, if it has
|
1317
|
+
# one. For more information, see [Referencing objects with external
|
1318
|
+
# IDs][1] in the *IoT SiteWise User Guide*.
|
1319
|
+
#
|
1320
|
+
#
|
1321
|
+
#
|
1322
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references
|
806
1323
|
# @return [String]
|
807
1324
|
#
|
808
1325
|
# @!attribute [rw] hierarchy_id
|
809
|
-
# The ID of a hierarchy in the parent asset's model.
|
810
|
-
#
|
811
|
-
# the
|
812
|
-
#
|
1326
|
+
# The ID of a hierarchy in the parent asset's model. (This can be
|
1327
|
+
# either the actual ID in UUID format, or else `externalId:` followed
|
1328
|
+
# by the external ID, if it has one. For more information, see
|
1329
|
+
# [Referencing objects with external IDs][1] in the *IoT SiteWise User
|
1330
|
+
# Guide*.) Hierarchies allow different groupings of assets to be
|
1331
|
+
# formed that all come from the same asset model. For more
|
1332
|
+
# information, see [Asset hierarchies][2] in the *IoT SiteWise User
|
1333
|
+
# Guide*.
|
813
1334
|
#
|
814
1335
|
#
|
815
1336
|
#
|
816
|
-
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/
|
1337
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references
|
1338
|
+
# [2]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html
|
817
1339
|
# @return [String]
|
818
1340
|
#
|
819
1341
|
# @!attribute [rw] child_asset_id
|
820
|
-
# The ID of the child asset to be associated.
|
1342
|
+
# The ID of the child asset to be associated. This can be either the
|
1343
|
+
# actual ID in UUID format, or else `externalId:` followed by the
|
1344
|
+
# external ID, if it has one. For more information, see [Referencing
|
1345
|
+
# objects with external IDs][1] in the *IoT SiteWise User Guide*.
|
1346
|
+
#
|
1347
|
+
#
|
1348
|
+
#
|
1349
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references
|
821
1350
|
# @return [String]
|
822
1351
|
#
|
823
1352
|
# @!attribute [rw] client_token
|
@@ -843,11 +1372,26 @@ module Aws::IoTSiteWise
|
|
843
1372
|
# @return [String]
|
844
1373
|
#
|
845
1374
|
# @!attribute [rw] asset_id
|
846
|
-
# The ID of the asset in which the asset property was created.
|
1375
|
+
# The ID of the asset in which the asset property was created. This
|
1376
|
+
# can be either the actual ID in UUID format, or else `externalId:`
|
1377
|
+
# followed by the external ID, if it has one. For more information,
|
1378
|
+
# see [Referencing objects with external IDs][1] in the *IoT SiteWise
|
1379
|
+
# User Guide*.
|
1380
|
+
#
|
1381
|
+
#
|
1382
|
+
#
|
1383
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references
|
847
1384
|
# @return [String]
|
848
1385
|
#
|
849
1386
|
# @!attribute [rw] property_id
|
850
|
-
# The ID of the asset property.
|
1387
|
+
# The ID of the asset property. This can be either the actual ID in
|
1388
|
+
# UUID format, or else `externalId:` followed by the external ID, if
|
1389
|
+
# it has one. For more information, see [Referencing objects with
|
1390
|
+
# external IDs][1] in the *IoT SiteWise User Guide*.
|
1391
|
+
#
|
1392
|
+
#
|
1393
|
+
#
|
1394
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references
|
851
1395
|
# @return [String]
|
852
1396
|
#
|
853
1397
|
# @!attribute [rw] client_token
|
@@ -871,7 +1415,7 @@ module Aws::IoTSiteWise
|
|
871
1415
|
# Contains a summary of an associated asset.
|
872
1416
|
#
|
873
1417
|
# @!attribute [rw] id
|
874
|
-
# The ID of the asset.
|
1418
|
+
# The ID of the asset, in UUID format.
|
875
1419
|
# @return [String]
|
876
1420
|
#
|
877
1421
|
# @!attribute [rw] arn
|
@@ -913,6 +1457,15 @@ module Aws::IoTSiteWise
|
|
913
1457
|
# A description for the asset.
|
914
1458
|
# @return [String]
|
915
1459
|
#
|
1460
|
+
# @!attribute [rw] external_id
|
1461
|
+
# The external ID of the asset. For more information, see [Using
|
1462
|
+
# external IDs][1] in the *IoT SiteWise User Guide*.
|
1463
|
+
#
|
1464
|
+
#
|
1465
|
+
#
|
1466
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
|
1467
|
+
# @return [String]
|
1468
|
+
#
|
916
1469
|
class AssociatedAssetsSummary < Struct.new(
|
917
1470
|
:id,
|
918
1471
|
:arn,
|
@@ -922,7 +1475,8 @@ module Aws::IoTSiteWise
|
|
922
1475
|
:last_update_date,
|
923
1476
|
:status,
|
924
1477
|
:hierarchies,
|
925
|
-
:description
|
1478
|
+
:description,
|
1479
|
+
:external_id)
|
926
1480
|
SENSITIVE = []
|
927
1481
|
include Aws::Structure
|
928
1482
|
end
|
@@ -1047,7 +1601,7 @@ module Aws::IoTSiteWise
|
|
1047
1601
|
# @return [String]
|
1048
1602
|
#
|
1049
1603
|
# @!attribute [rw] property_id
|
1050
|
-
# The ID of the asset property.
|
1604
|
+
# The ID of the asset property, in UUID format.
|
1051
1605
|
# @return [String]
|
1052
1606
|
#
|
1053
1607
|
# @!attribute [rw] property_alias
|
@@ -1294,7 +1848,7 @@ module Aws::IoTSiteWise
|
|
1294
1848
|
# @return [String]
|
1295
1849
|
#
|
1296
1850
|
# @!attribute [rw] property_id
|
1297
|
-
# The ID of the asset property.
|
1851
|
+
# The ID of the asset property, in UUID format.
|
1298
1852
|
# @return [String]
|
1299
1853
|
#
|
1300
1854
|
# @!attribute [rw] property_alias
|
@@ -1387,7 +1941,7 @@ module Aws::IoTSiteWise
|
|
1387
1941
|
# @return [String]
|
1388
1942
|
#
|
1389
1943
|
# @!attribute [rw] property_id
|
1390
|
-
# The ID of the asset property.
|
1944
|
+
# The ID of the asset property, in UUID format.
|
1391
1945
|
# @return [String]
|
1392
1946
|
#
|
1393
1947
|
# @!attribute [rw] property_alias
|
@@ -1757,6 +2311,35 @@ module Aws::IoTSiteWise
|
|
1757
2311
|
include Aws::Structure
|
1758
2312
|
end
|
1759
2313
|
|
2314
|
+
# A description of the column in the query results.
|
2315
|
+
#
|
2316
|
+
# @!attribute [rw] name
|
2317
|
+
# The name of the column description.
|
2318
|
+
# @return [String]
|
2319
|
+
#
|
2320
|
+
# @!attribute [rw] type
|
2321
|
+
# The type of the column description.
|
2322
|
+
# @return [Types::ColumnType]
|
2323
|
+
#
|
2324
|
+
class ColumnInfo < Struct.new(
|
2325
|
+
:name,
|
2326
|
+
:type)
|
2327
|
+
SENSITIVE = []
|
2328
|
+
include Aws::Structure
|
2329
|
+
end
|
2330
|
+
|
2331
|
+
# The data type of the column.
|
2332
|
+
#
|
2333
|
+
# @!attribute [rw] scalar_type
|
2334
|
+
# The allowed data types that the column has as it's value.
|
2335
|
+
# @return [String]
|
2336
|
+
#
|
2337
|
+
class ColumnType < Struct.new(
|
2338
|
+
:scalar_type)
|
2339
|
+
SENSITIVE = []
|
2340
|
+
include Aws::Structure
|
2341
|
+
end
|
2342
|
+
|
1760
2343
|
# Contains information about a composite model property on an asset.
|
1761
2344
|
#
|
1762
2345
|
# @!attribute [rw] name
|
@@ -1775,15 +2358,80 @@ module Aws::IoTSiteWise
|
|
1775
2358
|
# The ID of the composite model that contains the property.
|
1776
2359
|
# @return [String]
|
1777
2360
|
#
|
2361
|
+
# @!attribute [rw] external_id
|
2362
|
+
# The external ID of the composite model that contains the property.
|
2363
|
+
# For more information, see [Using external IDs][1] in the *IoT
|
2364
|
+
# SiteWise User Guide*.
|
2365
|
+
#
|
2366
|
+
#
|
2367
|
+
#
|
2368
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
|
2369
|
+
# @return [String]
|
2370
|
+
#
|
1778
2371
|
class CompositeModelProperty < Struct.new(
|
1779
2372
|
:name,
|
1780
2373
|
:type,
|
1781
2374
|
:asset_property,
|
2375
|
+
:id,
|
2376
|
+
:external_id)
|
2377
|
+
SENSITIVE = []
|
2378
|
+
include Aws::Structure
|
2379
|
+
end
|
2380
|
+
|
2381
|
+
# Metadata for the composition relationship established by using
|
2382
|
+
# `composedAssetModelId` in [ `CreateAssetModelCompositeModel` ][1].
|
2383
|
+
#
|
2384
|
+
#
|
2385
|
+
#
|
2386
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModelCompositeModel.html
|
2387
|
+
#
|
2388
|
+
# @!attribute [rw] composition_relationship
|
2389
|
+
# An array detailing the composition relationship for this composite
|
2390
|
+
# model.
|
2391
|
+
# @return [Array<Types::CompositionRelationshipItem>]
|
2392
|
+
#
|
2393
|
+
class CompositionDetails < Struct.new(
|
2394
|
+
:composition_relationship)
|
2395
|
+
SENSITIVE = []
|
2396
|
+
include Aws::Structure
|
2397
|
+
end
|
2398
|
+
|
2399
|
+
# Represents a composite model that composed an asset model of type
|
2400
|
+
# `COMPONENT_MODEL`.
|
2401
|
+
#
|
2402
|
+
# @!attribute [rw] id
|
2403
|
+
# The ID of the component.
|
2404
|
+
# @return [String]
|
2405
|
+
#
|
2406
|
+
class CompositionRelationshipItem < Struct.new(
|
1782
2407
|
:id)
|
1783
2408
|
SENSITIVE = []
|
1784
2409
|
include Aws::Structure
|
1785
2410
|
end
|
1786
2411
|
|
2412
|
+
# Contains a summary of the components of the composite model.
|
2413
|
+
#
|
2414
|
+
# @!attribute [rw] asset_model_id
|
2415
|
+
# The ID of the asset model, in UUID format.
|
2416
|
+
# @return [String]
|
2417
|
+
#
|
2418
|
+
# @!attribute [rw] asset_model_composite_model_id
|
2419
|
+
# The ID of a composite model on this asset model.
|
2420
|
+
# @return [String]
|
2421
|
+
#
|
2422
|
+
# @!attribute [rw] asset_model_composite_model_type
|
2423
|
+
# The composite model type. Valid values are `AWS/ALARM`, `CUSTOM`, or
|
2424
|
+
# ` AWS/L4E_ANOMALY`.
|
2425
|
+
# @return [String]
|
2426
|
+
#
|
2427
|
+
class CompositionRelationshipSummary < Struct.new(
|
2428
|
+
:asset_model_id,
|
2429
|
+
:asset_model_composite_model_id,
|
2430
|
+
:asset_model_composite_model_type)
|
2431
|
+
SENSITIVE = []
|
2432
|
+
include Aws::Structure
|
2433
|
+
end
|
2434
|
+
|
1787
2435
|
# Contains the details of an IoT SiteWise configuration error.
|
1788
2436
|
#
|
1789
2437
|
# @!attribute [rw] code
|
@@ -1865,43 +2513,149 @@ module Aws::IoTSiteWise
|
|
1865
2513
|
# not need to pass this option.
|
1866
2514
|
# @return [String]
|
1867
2515
|
#
|
1868
|
-
# @!attribute [rw] tags
|
1869
|
-
# A list of key-value pairs that contain metadata for the access
|
1870
|
-
# policy. For more information, see [Tagging your IoT SiteWise
|
1871
|
-
# resources][1] in the *IoT SiteWise User Guide*.
|
2516
|
+
# @!attribute [rw] tags
|
2517
|
+
# A list of key-value pairs that contain metadata for the access
|
2518
|
+
# policy. For more information, see [Tagging your IoT SiteWise
|
2519
|
+
# resources][1] in the *IoT SiteWise User Guide*.
|
2520
|
+
#
|
2521
|
+
#
|
2522
|
+
#
|
2523
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html
|
2524
|
+
# @return [Hash<String,String>]
|
2525
|
+
#
|
2526
|
+
class CreateAccessPolicyRequest < Struct.new(
|
2527
|
+
:access_policy_identity,
|
2528
|
+
:access_policy_resource,
|
2529
|
+
:access_policy_permission,
|
2530
|
+
:client_token,
|
2531
|
+
:tags)
|
2532
|
+
SENSITIVE = []
|
2533
|
+
include Aws::Structure
|
2534
|
+
end
|
2535
|
+
|
2536
|
+
# @!attribute [rw] access_policy_id
|
2537
|
+
# The ID of the access policy.
|
2538
|
+
# @return [String]
|
2539
|
+
#
|
2540
|
+
# @!attribute [rw] access_policy_arn
|
2541
|
+
# The [ARN][1] of the access policy, which has the following format.
|
2542
|
+
#
|
2543
|
+
# `arn:$\{Partition\}:iotsitewise:$\{Region\}:$\{Account\}:access-policy/$\{AccessPolicyId\}`
|
2544
|
+
#
|
2545
|
+
#
|
2546
|
+
#
|
2547
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
2548
|
+
# @return [String]
|
2549
|
+
#
|
2550
|
+
class CreateAccessPolicyResponse < Struct.new(
|
2551
|
+
:access_policy_id,
|
2552
|
+
:access_policy_arn)
|
2553
|
+
SENSITIVE = []
|
2554
|
+
include Aws::Structure
|
2555
|
+
end
|
2556
|
+
|
2557
|
+
# @!attribute [rw] asset_model_id
|
2558
|
+
# The ID of the asset model this composite model is a part of.
|
2559
|
+
# @return [String]
|
2560
|
+
#
|
2561
|
+
# @!attribute [rw] parent_asset_model_composite_model_id
|
2562
|
+
# The ID of the parent composite model in this asset model
|
2563
|
+
# relationship.
|
2564
|
+
# @return [String]
|
2565
|
+
#
|
2566
|
+
# @!attribute [rw] asset_model_composite_model_external_id
|
2567
|
+
# An external ID to assign to the composite model.
|
2568
|
+
#
|
2569
|
+
# If the composite model is a derived composite model, or one nested
|
2570
|
+
# inside a component model, you can only set the external ID using
|
2571
|
+
# `UpdateAssetModelCompositeModel` and specifying the derived ID of
|
2572
|
+
# the model or property from the created model it's a part of.
|
2573
|
+
# @return [String]
|
2574
|
+
#
|
2575
|
+
# @!attribute [rw] asset_model_composite_model_id
|
2576
|
+
# The ID of the composite model. IoT SiteWise automatically generates
|
2577
|
+
# a unique ID for you, so this parameter is never required. However,
|
2578
|
+
# if you prefer to supply your own ID instead, you can specify it here
|
2579
|
+
# in UUID format. If you specify your own ID, it must be globally
|
2580
|
+
# unique.
|
2581
|
+
# @return [String]
|
2582
|
+
#
|
2583
|
+
# @!attribute [rw] asset_model_composite_model_description
|
2584
|
+
# A description for the composite model.
|
2585
|
+
# @return [String]
|
2586
|
+
#
|
2587
|
+
# @!attribute [rw] asset_model_composite_model_name
|
2588
|
+
# A unique, friendly name for the composite model.
|
2589
|
+
# @return [String]
|
2590
|
+
#
|
2591
|
+
# @!attribute [rw] asset_model_composite_model_type
|
2592
|
+
# The composite model type. Valid values are `AWS/ALARM`, `CUSTOM`, or
|
2593
|
+
# ` AWS/L4E_ANOMALY`.
|
2594
|
+
# @return [String]
|
2595
|
+
#
|
2596
|
+
# @!attribute [rw] client_token
|
2597
|
+
# A unique case-sensitive identifier that you can provide to ensure
|
2598
|
+
# the idempotency of the request. Don't reuse this client token if a
|
2599
|
+
# new idempotent request is required.
|
2600
|
+
#
|
2601
|
+
# **A suitable default value is auto-generated.** You should normally
|
2602
|
+
# not need to pass this option.
|
2603
|
+
# @return [String]
|
2604
|
+
#
|
2605
|
+
# @!attribute [rw] composed_asset_model_id
|
2606
|
+
# The ID of a composite model on this asset.
|
2607
|
+
# @return [String]
|
1872
2608
|
#
|
2609
|
+
# @!attribute [rw] asset_model_composite_model_properties
|
2610
|
+
# The property definitions of the composite model. For more
|
2611
|
+
# information, see <LINK>.
|
1873
2612
|
#
|
2613
|
+
# You can specify up to 200 properties per composite model. For more
|
2614
|
+
# information, see [Quotas][1] in the *IoT SiteWise User Guide*.
|
1874
2615
|
#
|
1875
|
-
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html
|
1876
|
-
# @return [Hash<String,String>]
|
1877
2616
|
#
|
1878
|
-
|
1879
|
-
|
1880
|
-
|
1881
|
-
|
2617
|
+
#
|
2618
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html
|
2619
|
+
# @return [Array<Types::AssetModelPropertyDefinition>]
|
2620
|
+
#
|
2621
|
+
class CreateAssetModelCompositeModelRequest < Struct.new(
|
2622
|
+
:asset_model_id,
|
2623
|
+
:parent_asset_model_composite_model_id,
|
2624
|
+
:asset_model_composite_model_external_id,
|
2625
|
+
:asset_model_composite_model_id,
|
2626
|
+
:asset_model_composite_model_description,
|
2627
|
+
:asset_model_composite_model_name,
|
2628
|
+
:asset_model_composite_model_type,
|
1882
2629
|
:client_token,
|
1883
|
-
:
|
2630
|
+
:composed_asset_model_id,
|
2631
|
+
:asset_model_composite_model_properties)
|
1884
2632
|
SENSITIVE = []
|
1885
2633
|
include Aws::Structure
|
1886
2634
|
end
|
1887
2635
|
|
1888
|
-
# @!attribute [rw]
|
1889
|
-
# The ID of the
|
2636
|
+
# @!attribute [rw] asset_model_composite_model_id
|
2637
|
+
# The ID of the composed asset model. You can use this ID when you
|
2638
|
+
# call other IoT SiteWise APIs.
|
1890
2639
|
# @return [String]
|
1891
2640
|
#
|
1892
|
-
# @!attribute [rw]
|
1893
|
-
# The
|
2641
|
+
# @!attribute [rw] asset_model_composite_model_path
|
2642
|
+
# The path to the composite model listing the parent composite models.
|
2643
|
+
# @return [Array<Types::AssetModelCompositeModelPathSegment>]
|
1894
2644
|
#
|
1895
|
-
#
|
2645
|
+
# @!attribute [rw] asset_model_status
|
2646
|
+
# Contains current status information for an asset model. For more
|
2647
|
+
# information, see [Asset and model states][1] in the *IoT SiteWise
|
2648
|
+
# User Guide*.
|
1896
2649
|
#
|
1897
2650
|
#
|
1898
2651
|
#
|
1899
|
-
# [1]: https://docs.aws.amazon.com/
|
1900
|
-
# @return [
|
2652
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-and-model-states.html
|
2653
|
+
# @return [Types::AssetModelStatus]
|
1901
2654
|
#
|
1902
|
-
class
|
1903
|
-
:
|
1904
|
-
:
|
2655
|
+
class CreateAssetModelCompositeModelResponse < Struct.new(
|
2656
|
+
:asset_model_composite_model_id,
|
2657
|
+
:asset_model_composite_model_path,
|
2658
|
+
:asset_model_status)
|
1905
2659
|
SENSITIVE = []
|
1906
2660
|
include Aws::Structure
|
1907
2661
|
end
|
@@ -1943,11 +2697,22 @@ module Aws::IoTSiteWise
|
|
1943
2697
|
# @return [Array<Types::AssetModelHierarchyDefinition>]
|
1944
2698
|
#
|
1945
2699
|
# @!attribute [rw] asset_model_composite_models
|
1946
|
-
# The composite
|
1947
|
-
#
|
1948
|
-
#
|
1949
|
-
#
|
2700
|
+
# The composite models that are part of this asset model. It groups
|
2701
|
+
# properties (such as attributes, measurements, transforms, and
|
2702
|
+
# metrics) and child composite models that model parts of your
|
2703
|
+
# industrial equipment. Each composite model has a type that defines
|
2704
|
+
# the properties that the composite model supports. Use composite
|
1950
2705
|
# models to define alarms on this asset model.
|
2706
|
+
#
|
2707
|
+
# <note markdown="1"> When creating custom composite models, you need to use
|
2708
|
+
# [CreateAssetModelCompositeModel][1]. For more information, see
|
2709
|
+
# <LINK>.
|
2710
|
+
#
|
2711
|
+
# </note>
|
2712
|
+
#
|
2713
|
+
#
|
2714
|
+
#
|
2715
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModelCompositeModel.html
|
1951
2716
|
# @return [Array<Types::AssetModelCompositeModelDefinition>]
|
1952
2717
|
#
|
1953
2718
|
# @!attribute [rw] client_token
|
@@ -1969,6 +2734,37 @@ module Aws::IoTSiteWise
|
|
1969
2734
|
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html
|
1970
2735
|
# @return [Hash<String,String>]
|
1971
2736
|
#
|
2737
|
+
# @!attribute [rw] asset_model_id
|
2738
|
+
# The ID to assign to the asset model, if desired. IoT SiteWise
|
2739
|
+
# automatically generates a unique ID for you, so this parameter is
|
2740
|
+
# never required. However, if you prefer to supply your own ID
|
2741
|
+
# instead, you can specify it here in UUID format. If you specify your
|
2742
|
+
# own ID, it must be globally unique.
|
2743
|
+
# @return [String]
|
2744
|
+
#
|
2745
|
+
# @!attribute [rw] asset_model_external_id
|
2746
|
+
# An external ID to assign to the asset model. The external ID must be
|
2747
|
+
# unique within your Amazon Web Services account. For more
|
2748
|
+
# information, see [Using external IDs][1] in the *IoT SiteWise User
|
2749
|
+
# Guide*.
|
2750
|
+
#
|
2751
|
+
#
|
2752
|
+
#
|
2753
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
|
2754
|
+
# @return [String]
|
2755
|
+
#
|
2756
|
+
# @!attribute [rw] asset_model_type
|
2757
|
+
# The type of asset model.
|
2758
|
+
#
|
2759
|
+
# * **ASSET\_MODEL** – (default) An asset model that you can use to
|
2760
|
+
# create assets. Can't be included as a component in another asset
|
2761
|
+
# model.
|
2762
|
+
#
|
2763
|
+
# * **COMPONENT\_MODEL** – A reusable component that you can include
|
2764
|
+
# in the composite models of other asset models. You can't create
|
2765
|
+
# assets directly from this type of asset model.
|
2766
|
+
# @return [String]
|
2767
|
+
#
|
1972
2768
|
class CreateAssetModelRequest < Struct.new(
|
1973
2769
|
:asset_model_name,
|
1974
2770
|
:asset_model_description,
|
@@ -1976,14 +2772,17 @@ module Aws::IoTSiteWise
|
|
1976
2772
|
:asset_model_hierarchies,
|
1977
2773
|
:asset_model_composite_models,
|
1978
2774
|
:client_token,
|
1979
|
-
:tags
|
2775
|
+
:tags,
|
2776
|
+
:asset_model_id,
|
2777
|
+
:asset_model_external_id,
|
2778
|
+
:asset_model_type)
|
1980
2779
|
SENSITIVE = []
|
1981
2780
|
include Aws::Structure
|
1982
2781
|
end
|
1983
2782
|
|
1984
2783
|
# @!attribute [rw] asset_model_id
|
1985
|
-
# The ID of the asset model. You can use this ID when
|
1986
|
-
# IoT SiteWise
|
2784
|
+
# The ID of the asset model, in UUID format. You can use this ID when
|
2785
|
+
# you call other IoT SiteWise API operations.
|
1987
2786
|
# @return [String]
|
1988
2787
|
#
|
1989
2788
|
# @!attribute [rw] asset_model_arn
|
@@ -2014,7 +2813,15 @@ module Aws::IoTSiteWise
|
|
2014
2813
|
# @return [String]
|
2015
2814
|
#
|
2016
2815
|
# @!attribute [rw] asset_model_id
|
2017
|
-
# The ID of the asset model from which to create the asset.
|
2816
|
+
# The ID of the asset model from which to create the asset. This can
|
2817
|
+
# be either the actual ID in UUID format, or else `externalId:`
|
2818
|
+
# followed by the external ID, if it has one. For more information,
|
2819
|
+
# see [Referencing objects with external IDs][1] in the *IoT SiteWise
|
2820
|
+
# User Guide*.
|
2821
|
+
#
|
2822
|
+
#
|
2823
|
+
#
|
2824
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references
|
2018
2825
|
# @return [String]
|
2019
2826
|
#
|
2020
2827
|
# @!attribute [rw] client_token
|
@@ -2040,19 +2847,41 @@ module Aws::IoTSiteWise
|
|
2040
2847
|
# A description for the asset.
|
2041
2848
|
# @return [String]
|
2042
2849
|
#
|
2850
|
+
# @!attribute [rw] asset_id
|
2851
|
+
# The ID to assign to the asset, if desired. IoT SiteWise
|
2852
|
+
# automatically generates a unique ID for you, so this parameter is
|
2853
|
+
# never required. However, if you prefer to supply your own ID
|
2854
|
+
# instead, you can specify it here in UUID format. If you specify your
|
2855
|
+
# own ID, it must be globally unique.
|
2856
|
+
# @return [String]
|
2857
|
+
#
|
2858
|
+
# @!attribute [rw] asset_external_id
|
2859
|
+
# An external ID to assign to the asset. The external ID must be
|
2860
|
+
# unique within your Amazon Web Services account. For more
|
2861
|
+
# information, see [Using external IDs][1] in the *IoT SiteWise User
|
2862
|
+
# Guide*.
|
2863
|
+
#
|
2864
|
+
#
|
2865
|
+
#
|
2866
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
|
2867
|
+
# @return [String]
|
2868
|
+
#
|
2043
2869
|
class CreateAssetRequest < Struct.new(
|
2044
2870
|
:asset_name,
|
2045
2871
|
:asset_model_id,
|
2046
2872
|
:client_token,
|
2047
2873
|
:tags,
|
2048
|
-
:asset_description
|
2874
|
+
:asset_description,
|
2875
|
+
:asset_id,
|
2876
|
+
:asset_external_id)
|
2049
2877
|
SENSITIVE = []
|
2050
2878
|
include Aws::Structure
|
2051
2879
|
end
|
2052
2880
|
|
2053
2881
|
# @!attribute [rw] asset_id
|
2054
|
-
# The ID of the asset. This ID uniquely identifies the
|
2055
|
-
# IoT SiteWise and can be used with other IoT SiteWise
|
2882
|
+
# The ID of the asset, in UUID format. This ID uniquely identifies the
|
2883
|
+
# asset within IoT SiteWise and can be used with other IoT SiteWise
|
2884
|
+
# API operations.
|
2056
2885
|
# @return [String]
|
2057
2886
|
#
|
2058
2887
|
# @!attribute [rw] asset_arn
|
@@ -2105,12 +2934,26 @@ module Aws::IoTSiteWise
|
|
2105
2934
|
# format used to save data in Amazon S3.
|
2106
2935
|
# @return [Types::JobConfiguration]
|
2107
2936
|
#
|
2937
|
+
# @!attribute [rw] adaptive_ingestion
|
2938
|
+
# If set to true, ingest new data into IoT SiteWise storage.
|
2939
|
+
# Measurements with notifications, metrics and transforms are
|
2940
|
+
# computed. If set to false, historical data is ingested into IoT
|
2941
|
+
# SiteWise as is.
|
2942
|
+
# @return [Boolean]
|
2943
|
+
#
|
2944
|
+
# @!attribute [rw] delete_files_after_import
|
2945
|
+
# If set to true, your data files is deleted from S3, after ingestion
|
2946
|
+
# into IoT SiteWise storage.
|
2947
|
+
# @return [Boolean]
|
2948
|
+
#
|
2108
2949
|
class CreateBulkImportJobRequest < Struct.new(
|
2109
2950
|
:job_name,
|
2110
2951
|
:job_role_arn,
|
2111
2952
|
:files,
|
2112
2953
|
:error_report_location,
|
2113
|
-
:job_configuration
|
2954
|
+
:job_configuration,
|
2955
|
+
:adaptive_ingestion,
|
2956
|
+
:delete_files_after_import)
|
2114
2957
|
SENSITIVE = []
|
2115
2958
|
include Aws::Structure
|
2116
2959
|
end
|
@@ -2124,7 +2967,7 @@ module Aws::IoTSiteWise
|
|
2124
2967
|
# @return [String]
|
2125
2968
|
#
|
2126
2969
|
# @!attribute [rw] job_status
|
2127
|
-
# The status of the bulk import job can be one of following values
|
2970
|
+
# The status of the bulk import job can be one of following values:
|
2128
2971
|
#
|
2129
2972
|
# * `PENDING` – IoT SiteWise is waiting for the current bulk import
|
2130
2973
|
# job to finish.
|
@@ -2257,7 +3100,7 @@ module Aws::IoTSiteWise
|
|
2257
3100
|
|
2258
3101
|
# @!attribute [rw] gateway_id
|
2259
3102
|
# The ID of the gateway device. You can use this ID when you call
|
2260
|
-
# other IoT SiteWise
|
3103
|
+
# other IoT SiteWise API operations.
|
2261
3104
|
# @return [String]
|
2262
3105
|
#
|
2263
3106
|
# @!attribute [rw] gateway_arn
|
@@ -2329,13 +3172,12 @@ module Aws::IoTSiteWise
|
|
2329
3172
|
# The service to use to authenticate users to the portal. Choose from
|
2330
3173
|
# the following options:
|
2331
3174
|
#
|
2332
|
-
# * `SSO` – The portal uses IAM Identity Center
|
2333
|
-
#
|
2334
|
-
#
|
2335
|
-
#
|
2336
|
-
#
|
2337
|
-
#
|
2338
|
-
# the China Regions.
|
3175
|
+
# * `SSO` – The portal uses IAM Identity Center to authenticate users
|
3176
|
+
# and manage user permissions. Before you can create a portal that
|
3177
|
+
# uses IAM Identity Center, you must enable IAM Identity Center. For
|
3178
|
+
# more information, see [Enabling IAM Identity Center][1] in the
|
3179
|
+
# *IoT SiteWise User Guide*. This option is only available in Amazon
|
3180
|
+
# Web Services Regions other than the China Regions.
|
2339
3181
|
#
|
2340
3182
|
# * `IAM` – The portal uses Identity and Access Management to
|
2341
3183
|
# authenticate users and manage user permissions.
|
@@ -2492,7 +3334,7 @@ module Aws::IoTSiteWise
|
|
2492
3334
|
include Aws::Structure
|
2493
3335
|
end
|
2494
3336
|
|
2495
|
-
# A .
|
3337
|
+
# A .CSV file.
|
2496
3338
|
#
|
2497
3339
|
# @!attribute [rw] column_names
|
2498
3340
|
# The column names specified in the .csv file.
|
@@ -2565,6 +3407,34 @@ module Aws::IoTSiteWise
|
|
2565
3407
|
include Aws::Structure
|
2566
3408
|
end
|
2567
3409
|
|
3410
|
+
# Represents a single data point in a query result.
|
3411
|
+
#
|
3412
|
+
# @!attribute [rw] scalar_value
|
3413
|
+
# Indicates if the data point is a scalar value such as integer,
|
3414
|
+
# string, double, or Boolean.
|
3415
|
+
# @return [String]
|
3416
|
+
#
|
3417
|
+
# @!attribute [rw] array_value
|
3418
|
+
# Indicates if the data point is an array.
|
3419
|
+
# @return [Array<Types::Datum>]
|
3420
|
+
#
|
3421
|
+
# @!attribute [rw] row_value
|
3422
|
+
# Indicates if the data point is a row.
|
3423
|
+
# @return [Types::Row]
|
3424
|
+
#
|
3425
|
+
# @!attribute [rw] null_value
|
3426
|
+
# Indicates if the data point is null.
|
3427
|
+
# @return [Boolean]
|
3428
|
+
#
|
3429
|
+
class Datum < Struct.new(
|
3430
|
+
:scalar_value,
|
3431
|
+
:array_value,
|
3432
|
+
:row_value,
|
3433
|
+
:null_value)
|
3434
|
+
SENSITIVE = []
|
3435
|
+
include Aws::Structure
|
3436
|
+
end
|
3437
|
+
|
2568
3438
|
# @!attribute [rw] access_policy_id
|
2569
3439
|
# The ID of the access policy to be deleted.
|
2570
3440
|
# @return [String]
|
@@ -2588,7 +3458,55 @@ module Aws::IoTSiteWise
|
|
2588
3458
|
class DeleteAccessPolicyResponse < Aws::EmptyStructure; end
|
2589
3459
|
|
2590
3460
|
# @!attribute [rw] asset_model_id
|
2591
|
-
# The ID of the asset model
|
3461
|
+
# The ID of the asset model, in UUID format.
|
3462
|
+
# @return [String]
|
3463
|
+
#
|
3464
|
+
# @!attribute [rw] asset_model_composite_model_id
|
3465
|
+
# The ID of a composite model on this asset model.
|
3466
|
+
# @return [String]
|
3467
|
+
#
|
3468
|
+
# @!attribute [rw] client_token
|
3469
|
+
# A unique case-sensitive identifier that you can provide to ensure
|
3470
|
+
# the idempotency of the request. Don't reuse this client token if a
|
3471
|
+
# new idempotent request is required.
|
3472
|
+
#
|
3473
|
+
# **A suitable default value is auto-generated.** You should normally
|
3474
|
+
# not need to pass this option.
|
3475
|
+
# @return [String]
|
3476
|
+
#
|
3477
|
+
class DeleteAssetModelCompositeModelRequest < Struct.new(
|
3478
|
+
:asset_model_id,
|
3479
|
+
:asset_model_composite_model_id,
|
3480
|
+
:client_token)
|
3481
|
+
SENSITIVE = []
|
3482
|
+
include Aws::Structure
|
3483
|
+
end
|
3484
|
+
|
3485
|
+
# @!attribute [rw] asset_model_status
|
3486
|
+
# Contains current status information for an asset model. For more
|
3487
|
+
# information, see [Asset and model states][1] in the *IoT SiteWise
|
3488
|
+
# User Guide*.
|
3489
|
+
#
|
3490
|
+
#
|
3491
|
+
#
|
3492
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-and-model-states.html
|
3493
|
+
# @return [Types::AssetModelStatus]
|
3494
|
+
#
|
3495
|
+
class DeleteAssetModelCompositeModelResponse < Struct.new(
|
3496
|
+
:asset_model_status)
|
3497
|
+
SENSITIVE = []
|
3498
|
+
include Aws::Structure
|
3499
|
+
end
|
3500
|
+
|
3501
|
+
# @!attribute [rw] asset_model_id
|
3502
|
+
# The ID of the asset model to delete. This can be either the actual
|
3503
|
+
# ID in UUID format, or else `externalId:` followed by the external
|
3504
|
+
# ID, if it has one. For more information, see [Referencing objects
|
3505
|
+
# with external IDs][1] in the *IoT SiteWise User Guide*.
|
3506
|
+
#
|
3507
|
+
#
|
3508
|
+
#
|
3509
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references
|
2592
3510
|
# @return [String]
|
2593
3511
|
#
|
2594
3512
|
# @!attribute [rw] client_token
|
@@ -2619,7 +3537,14 @@ module Aws::IoTSiteWise
|
|
2619
3537
|
end
|
2620
3538
|
|
2621
3539
|
# @!attribute [rw] asset_id
|
2622
|
-
# The ID of the asset to delete.
|
3540
|
+
# The ID of the asset to delete. This can be either the actual ID in
|
3541
|
+
# UUID format, or else `externalId:` followed by the external ID, if
|
3542
|
+
# it has one. For more information, see [Referencing objects with
|
3543
|
+
# external IDs][1] in the *IoT SiteWise User Guide*.
|
3544
|
+
#
|
3545
|
+
#
|
3546
|
+
#
|
3547
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references
|
2623
3548
|
# @return [String]
|
2624
3549
|
#
|
2625
3550
|
# @!attribute [rw] client_token
|
@@ -2739,11 +3664,26 @@ module Aws::IoTSiteWise
|
|
2739
3664
|
# @return [String]
|
2740
3665
|
#
|
2741
3666
|
# @!attribute [rw] asset_id
|
2742
|
-
# The ID of the asset in which the asset property was created.
|
3667
|
+
# The ID of the asset in which the asset property was created. This
|
3668
|
+
# can be either the actual ID in UUID format, or else `externalId:`
|
3669
|
+
# followed by the external ID, if it has one. For more information,
|
3670
|
+
# see [Referencing objects with external IDs][1] in the *IoT SiteWise
|
3671
|
+
# User Guide*.
|
3672
|
+
#
|
3673
|
+
#
|
3674
|
+
#
|
3675
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references
|
2743
3676
|
# @return [String]
|
2744
3677
|
#
|
2745
3678
|
# @!attribute [rw] property_id
|
2746
|
-
# The ID of the asset property.
|
3679
|
+
# The ID of the asset property. This can be either the actual ID in
|
3680
|
+
# UUID format, or else `externalId:` followed by the external ID, if
|
3681
|
+
# it has one. For more information, see [Referencing objects with
|
3682
|
+
# external IDs][1] in the *IoT SiteWise User Guide*.
|
3683
|
+
#
|
3684
|
+
#
|
3685
|
+
#
|
3686
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references
|
2747
3687
|
# @return [String]
|
2748
3688
|
#
|
2749
3689
|
# @!attribute [rw] client_token
|
@@ -2751,80 +3691,317 @@ module Aws::IoTSiteWise
|
|
2751
3691
|
# the idempotency of the request. Don't reuse this client token if a
|
2752
3692
|
# new idempotent request is required.
|
2753
3693
|
#
|
2754
|
-
# **A suitable default value is auto-generated.** You should normally
|
2755
|
-
# not need to pass this option.
|
3694
|
+
# **A suitable default value is auto-generated.** You should normally
|
3695
|
+
# not need to pass this option.
|
3696
|
+
# @return [String]
|
3697
|
+
#
|
3698
|
+
class DeleteTimeSeriesRequest < Struct.new(
|
3699
|
+
:alias,
|
3700
|
+
:asset_id,
|
3701
|
+
:property_id,
|
3702
|
+
:client_token)
|
3703
|
+
SENSITIVE = []
|
3704
|
+
include Aws::Structure
|
3705
|
+
end
|
3706
|
+
|
3707
|
+
# @!attribute [rw] access_policy_id
|
3708
|
+
# The ID of the access policy.
|
3709
|
+
# @return [String]
|
3710
|
+
#
|
3711
|
+
class DescribeAccessPolicyRequest < Struct.new(
|
3712
|
+
:access_policy_id)
|
3713
|
+
SENSITIVE = []
|
3714
|
+
include Aws::Structure
|
3715
|
+
end
|
3716
|
+
|
3717
|
+
# @!attribute [rw] access_policy_id
|
3718
|
+
# The ID of the access policy.
|
3719
|
+
# @return [String]
|
3720
|
+
#
|
3721
|
+
# @!attribute [rw] access_policy_arn
|
3722
|
+
# The [ARN][1] of the access policy, which has the following format.
|
3723
|
+
#
|
3724
|
+
# `arn:$\{Partition\}:iotsitewise:$\{Region\}:$\{Account\}:access-policy/$\{AccessPolicyId\}`
|
3725
|
+
#
|
3726
|
+
#
|
3727
|
+
#
|
3728
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
3729
|
+
# @return [String]
|
3730
|
+
#
|
3731
|
+
# @!attribute [rw] access_policy_identity
|
3732
|
+
# The identity (IAM Identity Center user, IAM Identity Center group,
|
3733
|
+
# or IAM user) to which this access policy applies.
|
3734
|
+
# @return [Types::Identity]
|
3735
|
+
#
|
3736
|
+
# @!attribute [rw] access_policy_resource
|
3737
|
+
# The IoT SiteWise Monitor resource (portal or project) to which this
|
3738
|
+
# access policy provides access.
|
3739
|
+
# @return [Types::Resource]
|
3740
|
+
#
|
3741
|
+
# @!attribute [rw] access_policy_permission
|
3742
|
+
# The access policy permission. Note that a project `ADMINISTRATOR` is
|
3743
|
+
# also known as a project owner.
|
3744
|
+
# @return [String]
|
3745
|
+
#
|
3746
|
+
# @!attribute [rw] access_policy_creation_date
|
3747
|
+
# The date the access policy was created, in Unix epoch time.
|
3748
|
+
# @return [Time]
|
3749
|
+
#
|
3750
|
+
# @!attribute [rw] access_policy_last_update_date
|
3751
|
+
# The date the access policy was last updated, in Unix epoch time.
|
3752
|
+
# @return [Time]
|
3753
|
+
#
|
3754
|
+
class DescribeAccessPolicyResponse < Struct.new(
|
3755
|
+
:access_policy_id,
|
3756
|
+
:access_policy_arn,
|
3757
|
+
:access_policy_identity,
|
3758
|
+
:access_policy_resource,
|
3759
|
+
:access_policy_permission,
|
3760
|
+
:access_policy_creation_date,
|
3761
|
+
:access_policy_last_update_date)
|
3762
|
+
SENSITIVE = []
|
3763
|
+
include Aws::Structure
|
3764
|
+
end
|
3765
|
+
|
3766
|
+
# @!attribute [rw] action_id
|
3767
|
+
# The ID of the action.
|
3768
|
+
# @return [String]
|
3769
|
+
#
|
3770
|
+
class DescribeActionRequest < Struct.new(
|
3771
|
+
:action_id)
|
3772
|
+
SENSITIVE = []
|
3773
|
+
include Aws::Structure
|
3774
|
+
end
|
3775
|
+
|
3776
|
+
# @!attribute [rw] action_id
|
3777
|
+
# The ID of the action.
|
3778
|
+
# @return [String]
|
3779
|
+
#
|
3780
|
+
# @!attribute [rw] target_resource
|
3781
|
+
# The resource the action will be taken on.
|
3782
|
+
# @return [Types::TargetResource]
|
3783
|
+
#
|
3784
|
+
# @!attribute [rw] action_definition_id
|
3785
|
+
# The ID of the action definition.
|
3786
|
+
# @return [String]
|
3787
|
+
#
|
3788
|
+
# @!attribute [rw] action_payload
|
3789
|
+
# The JSON payload of the action.
|
3790
|
+
# @return [Types::ActionPayload]
|
3791
|
+
#
|
3792
|
+
# @!attribute [rw] execution_time
|
3793
|
+
# The time the action was executed.
|
3794
|
+
# @return [Time]
|
3795
|
+
#
|
3796
|
+
class DescribeActionResponse < Struct.new(
|
3797
|
+
:action_id,
|
3798
|
+
:target_resource,
|
3799
|
+
:action_definition_id,
|
3800
|
+
:action_payload,
|
3801
|
+
:execution_time)
|
3802
|
+
SENSITIVE = []
|
3803
|
+
include Aws::Structure
|
3804
|
+
end
|
3805
|
+
|
3806
|
+
# @!attribute [rw] asset_id
|
3807
|
+
# The ID of the asset. This can be either the actual ID in UUID
|
3808
|
+
# format, or else `externalId:` followed by the external ID, if it has
|
3809
|
+
# one. For more information, see [Referencing objects with external
|
3810
|
+
# IDs][1] in the *IoT SiteWise User Guide*.
|
3811
|
+
#
|
3812
|
+
#
|
3813
|
+
#
|
3814
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references
|
3815
|
+
# @return [String]
|
3816
|
+
#
|
3817
|
+
# @!attribute [rw] asset_composite_model_id
|
3818
|
+
# The ID of a composite model on this asset. This can be either the
|
3819
|
+
# actual ID in UUID format, or else `externalId:` followed by the
|
3820
|
+
# external ID, if it has one. For more information, see [Referencing
|
3821
|
+
# objects with external IDs][1] in the *IoT SiteWise User Guide*.
|
3822
|
+
#
|
3823
|
+
#
|
3824
|
+
#
|
3825
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references
|
3826
|
+
# @return [String]
|
3827
|
+
#
|
3828
|
+
class DescribeAssetCompositeModelRequest < Struct.new(
|
3829
|
+
:asset_id,
|
3830
|
+
:asset_composite_model_id)
|
3831
|
+
SENSITIVE = []
|
3832
|
+
include Aws::Structure
|
3833
|
+
end
|
3834
|
+
|
3835
|
+
# @!attribute [rw] asset_id
|
3836
|
+
# The ID of the asset, in UUID format. This ID uniquely identifies the
|
3837
|
+
# asset within IoT SiteWise and can be used with other IoT SiteWise
|
3838
|
+
# APIs.
|
3839
|
+
# @return [String]
|
3840
|
+
#
|
3841
|
+
# @!attribute [rw] asset_composite_model_id
|
3842
|
+
# The ID of a composite model on this asset.
|
3843
|
+
# @return [String]
|
3844
|
+
#
|
3845
|
+
# @!attribute [rw] asset_composite_model_external_id
|
3846
|
+
# An external ID to assign to the asset model.
|
3847
|
+
#
|
3848
|
+
# If the composite model is a component-based composite model, or one
|
3849
|
+
# nested inside a component model, you can only set the external ID
|
3850
|
+
# using `UpdateAssetModelCompositeModel` and specifying the derived ID
|
3851
|
+
# of the model or property from the created model it's a part of.
|
3852
|
+
# @return [String]
|
3853
|
+
#
|
3854
|
+
# @!attribute [rw] asset_composite_model_path
|
3855
|
+
# The path to the composite model listing the parent composite models.
|
3856
|
+
# @return [Array<Types::AssetCompositeModelPathSegment>]
|
3857
|
+
#
|
3858
|
+
# @!attribute [rw] asset_composite_model_name
|
3859
|
+
# The unique, friendly name for the composite model.
|
3860
|
+
# @return [String]
|
3861
|
+
#
|
3862
|
+
# @!attribute [rw] asset_composite_model_description
|
3863
|
+
# A description for the composite model.
|
3864
|
+
# @return [String]
|
3865
|
+
#
|
3866
|
+
# @!attribute [rw] asset_composite_model_type
|
3867
|
+
# The composite model type. Valid values are `AWS/ALARM`, `CUSTOM`, or
|
3868
|
+
# ` AWS/L4E_ANOMALY`.
|
2756
3869
|
# @return [String]
|
2757
3870
|
#
|
2758
|
-
|
2759
|
-
|
3871
|
+
# @!attribute [rw] asset_composite_model_properties
|
3872
|
+
# The property definitions of the composite model that was used to
|
3873
|
+
# create the asset.
|
3874
|
+
# @return [Array<Types::AssetProperty>]
|
3875
|
+
#
|
3876
|
+
# @!attribute [rw] asset_composite_model_summaries
|
3877
|
+
# The list of composite model summaries.
|
3878
|
+
# @return [Array<Types::AssetCompositeModelSummary>]
|
3879
|
+
#
|
3880
|
+
# @!attribute [rw] action_definitions
|
3881
|
+
# The available actions for a composite model on this asset.
|
3882
|
+
# @return [Array<Types::ActionDefinition>]
|
3883
|
+
#
|
3884
|
+
class DescribeAssetCompositeModelResponse < Struct.new(
|
2760
3885
|
:asset_id,
|
2761
|
-
:
|
2762
|
-
:
|
3886
|
+
:asset_composite_model_id,
|
3887
|
+
:asset_composite_model_external_id,
|
3888
|
+
:asset_composite_model_path,
|
3889
|
+
:asset_composite_model_name,
|
3890
|
+
:asset_composite_model_description,
|
3891
|
+
:asset_composite_model_type,
|
3892
|
+
:asset_composite_model_properties,
|
3893
|
+
:asset_composite_model_summaries,
|
3894
|
+
:action_definitions)
|
2763
3895
|
SENSITIVE = []
|
2764
3896
|
include Aws::Structure
|
2765
3897
|
end
|
2766
3898
|
|
2767
|
-
# @!attribute [rw]
|
2768
|
-
# The ID of the
|
3899
|
+
# @!attribute [rw] asset_model_id
|
3900
|
+
# The ID of the asset model. This can be either the actual ID in UUID
|
3901
|
+
# format, or else `externalId:` followed by the external ID, if it has
|
3902
|
+
# one. For more information, see [Referencing objects with external
|
3903
|
+
# IDs][1] in the *IoT SiteWise User Guide*.
|
3904
|
+
#
|
3905
|
+
#
|
3906
|
+
#
|
3907
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references
|
2769
3908
|
# @return [String]
|
2770
3909
|
#
|
2771
|
-
|
2772
|
-
|
3910
|
+
# @!attribute [rw] asset_model_composite_model_id
|
3911
|
+
# The ID of a composite model on this asset model. This can be either
|
3912
|
+
# the actual ID in UUID format, or else `externalId:` followed by the
|
3913
|
+
# external ID, if it has one. For more information, see [Referencing
|
3914
|
+
# objects with external IDs][1] in the *IoT SiteWise User Guide*.
|
3915
|
+
#
|
3916
|
+
#
|
3917
|
+
#
|
3918
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references
|
3919
|
+
# @return [String]
|
3920
|
+
#
|
3921
|
+
class DescribeAssetModelCompositeModelRequest < Struct.new(
|
3922
|
+
:asset_model_id,
|
3923
|
+
:asset_model_composite_model_id)
|
2773
3924
|
SENSITIVE = []
|
2774
3925
|
include Aws::Structure
|
2775
3926
|
end
|
2776
3927
|
|
2777
|
-
# @!attribute [rw]
|
2778
|
-
# The ID of the
|
3928
|
+
# @!attribute [rw] asset_model_id
|
3929
|
+
# The ID of the asset model, in UUID format.
|
2779
3930
|
# @return [String]
|
2780
3931
|
#
|
2781
|
-
# @!attribute [rw]
|
2782
|
-
# The
|
3932
|
+
# @!attribute [rw] asset_model_composite_model_id
|
3933
|
+
# The ID of a composite model on this asset model.
|
3934
|
+
# @return [String]
|
2783
3935
|
#
|
2784
|
-
#
|
3936
|
+
# @!attribute [rw] asset_model_composite_model_external_id
|
3937
|
+
# The external ID of a composite model on this asset model.
|
3938
|
+
# @return [String]
|
2785
3939
|
#
|
3940
|
+
# @!attribute [rw] asset_model_composite_model_path
|
3941
|
+
# The path to the composite model listing the parent composite models.
|
3942
|
+
# @return [Array<Types::AssetModelCompositeModelPathSegment>]
|
2786
3943
|
#
|
3944
|
+
# @!attribute [rw] asset_model_composite_model_name
|
3945
|
+
# The unique, friendly name for the composite model.
|
3946
|
+
# @return [String]
|
2787
3947
|
#
|
2788
|
-
#
|
3948
|
+
# @!attribute [rw] asset_model_composite_model_description
|
3949
|
+
# The description for the composite model.
|
2789
3950
|
# @return [String]
|
2790
3951
|
#
|
2791
|
-
# @!attribute [rw]
|
2792
|
-
# The
|
2793
|
-
#
|
2794
|
-
# @return [
|
3952
|
+
# @!attribute [rw] asset_model_composite_model_type
|
3953
|
+
# The composite model type. Valid values are `AWS/ALARM`, `CUSTOM`, or
|
3954
|
+
# ` AWS/L4E_ANOMALY`.
|
3955
|
+
# @return [String]
|
2795
3956
|
#
|
2796
|
-
# @!attribute [rw]
|
2797
|
-
# The
|
2798
|
-
#
|
2799
|
-
# @return [Types::Resource]
|
3957
|
+
# @!attribute [rw] asset_model_composite_model_properties
|
3958
|
+
# The property definitions of the composite model.
|
3959
|
+
# @return [Array<Types::AssetModelProperty>]
|
2800
3960
|
#
|
2801
|
-
# @!attribute [rw]
|
2802
|
-
#
|
2803
|
-
#
|
2804
|
-
#
|
3961
|
+
# @!attribute [rw] composition_details
|
3962
|
+
# Metadata for the composition relationship established by using
|
3963
|
+
# `composedAssetModelId` in [ `CreateAssetModelCompositeModel` ][1].
|
3964
|
+
# For instance, an array detailing the path of the composition
|
3965
|
+
# relationship for this composite model.
|
2805
3966
|
#
|
2806
|
-
# @!attribute [rw] access_policy_creation_date
|
2807
|
-
# The date the access policy was created, in Unix epoch time.
|
2808
|
-
# @return [Time]
|
2809
3967
|
#
|
2810
|
-
# @!attribute [rw] access_policy_last_update_date
|
2811
|
-
# The date the access policy was last updated, in Unix epoch time.
|
2812
|
-
# @return [Time]
|
2813
3968
|
#
|
2814
|
-
|
2815
|
-
|
2816
|
-
|
2817
|
-
|
2818
|
-
|
2819
|
-
|
2820
|
-
|
2821
|
-
|
3969
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModelCompositeModel.html
|
3970
|
+
# @return [Types::CompositionDetails]
|
3971
|
+
#
|
3972
|
+
# @!attribute [rw] asset_model_composite_model_summaries
|
3973
|
+
# The list of composite model summaries for the composite model.
|
3974
|
+
# @return [Array<Types::AssetModelCompositeModelSummary>]
|
3975
|
+
#
|
3976
|
+
# @!attribute [rw] action_definitions
|
3977
|
+
# The available actions for a composite model on this asset model.
|
3978
|
+
# @return [Array<Types::ActionDefinition>]
|
3979
|
+
#
|
3980
|
+
class DescribeAssetModelCompositeModelResponse < Struct.new(
|
3981
|
+
:asset_model_id,
|
3982
|
+
:asset_model_composite_model_id,
|
3983
|
+
:asset_model_composite_model_external_id,
|
3984
|
+
:asset_model_composite_model_path,
|
3985
|
+
:asset_model_composite_model_name,
|
3986
|
+
:asset_model_composite_model_description,
|
3987
|
+
:asset_model_composite_model_type,
|
3988
|
+
:asset_model_composite_model_properties,
|
3989
|
+
:composition_details,
|
3990
|
+
:asset_model_composite_model_summaries,
|
3991
|
+
:action_definitions)
|
2822
3992
|
SENSITIVE = []
|
2823
3993
|
include Aws::Structure
|
2824
3994
|
end
|
2825
3995
|
|
2826
3996
|
# @!attribute [rw] asset_model_id
|
2827
|
-
# The ID of the asset model.
|
3997
|
+
# The ID of the asset model. This can be either the actual ID in UUID
|
3998
|
+
# format, or else `externalId:` followed by the external ID, if it has
|
3999
|
+
# one. For more information, see [Referencing objects with external
|
4000
|
+
# IDs][1] in the *IoT SiteWise User Guide*.
|
4001
|
+
#
|
4002
|
+
#
|
4003
|
+
#
|
4004
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references
|
2828
4005
|
# @return [String]
|
2829
4006
|
#
|
2830
4007
|
# @!attribute [rw] exclude_properties
|
@@ -2839,7 +4016,7 @@ module Aws::IoTSiteWise
|
|
2839
4016
|
end
|
2840
4017
|
|
2841
4018
|
# @!attribute [rw] asset_model_id
|
2842
|
-
# The ID of the asset model.
|
4019
|
+
# The ID of the asset model, in UUID format.
|
2843
4020
|
# @return [String]
|
2844
4021
|
#
|
2845
4022
|
# @!attribute [rw] asset_model_arn
|
@@ -2876,7 +4053,8 @@ module Aws::IoTSiteWise
|
|
2876
4053
|
# @return [Array<Types::AssetModelHierarchy>]
|
2877
4054
|
#
|
2878
4055
|
# @!attribute [rw] asset_model_composite_models
|
2879
|
-
# The list of composite
|
4056
|
+
# The list of built-in composite models for the asset model, such as
|
4057
|
+
# those with those of type `AWS/ALARMS`.
|
2880
4058
|
# @return [Array<Types::AssetModelCompositeModel>]
|
2881
4059
|
#
|
2882
4060
|
# @!attribute [rw] asset_model_creation_date
|
@@ -2892,6 +4070,27 @@ module Aws::IoTSiteWise
|
|
2892
4070
|
# any error message.
|
2893
4071
|
# @return [Types::AssetModelStatus]
|
2894
4072
|
#
|
4073
|
+
# @!attribute [rw] asset_model_type
|
4074
|
+
# The type of asset model.
|
4075
|
+
#
|
4076
|
+
# * **ASSET\_MODEL** – (default) An asset model that you can use to
|
4077
|
+
# create assets. Can't be included as a component in another asset
|
4078
|
+
# model.
|
4079
|
+
#
|
4080
|
+
# * **COMPONENT\_MODEL** – A reusable component that you can include
|
4081
|
+
# in the composite models of other asset models. You can't create
|
4082
|
+
# assets directly from this type of asset model.
|
4083
|
+
# @return [String]
|
4084
|
+
#
|
4085
|
+
# @!attribute [rw] asset_model_composite_model_summaries
|
4086
|
+
# The list of the immediate child custom composite model summaries for
|
4087
|
+
# the asset model.
|
4088
|
+
# @return [Array<Types::AssetModelCompositeModelSummary>]
|
4089
|
+
#
|
4090
|
+
# @!attribute [rw] asset_model_external_id
|
4091
|
+
# The external ID of the asset model, if any.
|
4092
|
+
# @return [String]
|
4093
|
+
#
|
2895
4094
|
class DescribeAssetModelResponse < Struct.new(
|
2896
4095
|
:asset_model_id,
|
2897
4096
|
:asset_model_arn,
|
@@ -2902,17 +4101,34 @@ module Aws::IoTSiteWise
|
|
2902
4101
|
:asset_model_composite_models,
|
2903
4102
|
:asset_model_creation_date,
|
2904
4103
|
:asset_model_last_update_date,
|
2905
|
-
:asset_model_status
|
4104
|
+
:asset_model_status,
|
4105
|
+
:asset_model_type,
|
4106
|
+
:asset_model_composite_model_summaries,
|
4107
|
+
:asset_model_external_id)
|
2906
4108
|
SENSITIVE = []
|
2907
4109
|
include Aws::Structure
|
2908
4110
|
end
|
2909
4111
|
|
2910
4112
|
# @!attribute [rw] asset_id
|
2911
|
-
# The ID of the asset.
|
4113
|
+
# The ID of the asset. This can be either the actual ID in UUID
|
4114
|
+
# format, or else `externalId:` followed by the external ID, if it has
|
4115
|
+
# one. For more information, see [Referencing objects with external
|
4116
|
+
# IDs][1] in the *IoT SiteWise User Guide*.
|
4117
|
+
#
|
4118
|
+
#
|
4119
|
+
#
|
4120
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references
|
2912
4121
|
# @return [String]
|
2913
4122
|
#
|
2914
4123
|
# @!attribute [rw] property_id
|
2915
|
-
# The ID of the asset property.
|
4124
|
+
# The ID of the asset property. This can be either the actual ID in
|
4125
|
+
# UUID format, or else `externalId:` followed by the external ID, if
|
4126
|
+
# it has one. For more information, see [Referencing objects with
|
4127
|
+
# external IDs][1] in the *IoT SiteWise User Guide*.
|
4128
|
+
#
|
4129
|
+
#
|
4130
|
+
#
|
4131
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references
|
2916
4132
|
# @return [String]
|
2917
4133
|
#
|
2918
4134
|
class DescribeAssetPropertyRequest < Struct.new(
|
@@ -2923,7 +4139,7 @@ module Aws::IoTSiteWise
|
|
2923
4139
|
end
|
2924
4140
|
|
2925
4141
|
# @!attribute [rw] asset_id
|
2926
|
-
# The ID of the asset.
|
4142
|
+
# The ID of the asset, in UUID format.
|
2927
4143
|
# @return [String]
|
2928
4144
|
#
|
2929
4145
|
# @!attribute [rw] asset_name
|
@@ -2931,7 +4147,7 @@ module Aws::IoTSiteWise
|
|
2931
4147
|
# @return [String]
|
2932
4148
|
#
|
2933
4149
|
# @!attribute [rw] asset_model_id
|
2934
|
-
# The ID of the asset model.
|
4150
|
+
# The ID of the asset model, in UUID format.
|
2935
4151
|
# @return [String]
|
2936
4152
|
#
|
2937
4153
|
# @!attribute [rw] asset_property
|
@@ -2943,22 +4159,39 @@ module Aws::IoTSiteWise
|
|
2943
4159
|
# @return [Types::Property]
|
2944
4160
|
#
|
2945
4161
|
# @!attribute [rw] composite_model
|
2946
|
-
# The composite
|
2947
|
-
#
|
4162
|
+
# The composite model that declares this asset property, if this asset
|
4163
|
+
# property exists in a composite model.
|
2948
4164
|
# @return [Types::CompositeModelProperty]
|
2949
4165
|
#
|
4166
|
+
# @!attribute [rw] asset_external_id
|
4167
|
+
# The external ID of the asset. For more information, see [Using
|
4168
|
+
# external IDs][1] in the *IoT SiteWise User Guide*.
|
4169
|
+
#
|
4170
|
+
#
|
4171
|
+
#
|
4172
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
|
4173
|
+
# @return [String]
|
4174
|
+
#
|
2950
4175
|
class DescribeAssetPropertyResponse < Struct.new(
|
2951
4176
|
:asset_id,
|
2952
4177
|
:asset_name,
|
2953
4178
|
:asset_model_id,
|
2954
4179
|
:asset_property,
|
2955
|
-
:composite_model
|
4180
|
+
:composite_model,
|
4181
|
+
:asset_external_id)
|
2956
4182
|
SENSITIVE = []
|
2957
4183
|
include Aws::Structure
|
2958
4184
|
end
|
2959
4185
|
|
2960
4186
|
# @!attribute [rw] asset_id
|
2961
|
-
# The ID of the asset.
|
4187
|
+
# The ID of the asset. This can be either the actual ID in UUID
|
4188
|
+
# format, or else `externalId:` followed by the external ID, if it has
|
4189
|
+
# one. For more information, see [Referencing objects with external
|
4190
|
+
# IDs][1] in the *IoT SiteWise User Guide*.
|
4191
|
+
#
|
4192
|
+
#
|
4193
|
+
#
|
4194
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references
|
2962
4195
|
# @return [String]
|
2963
4196
|
#
|
2964
4197
|
# @!attribute [rw] exclude_properties
|
@@ -2973,7 +4206,7 @@ module Aws::IoTSiteWise
|
|
2973
4206
|
end
|
2974
4207
|
|
2975
4208
|
# @!attribute [rw] asset_id
|
2976
|
-
# The ID of the asset.
|
4209
|
+
# The ID of the asset, in UUID format.
|
2977
4210
|
# @return [String]
|
2978
4211
|
#
|
2979
4212
|
# @!attribute [rw] asset_arn
|
@@ -3028,6 +4261,15 @@ module Aws::IoTSiteWise
|
|
3028
4261
|
# A description for the asset.
|
3029
4262
|
# @return [String]
|
3030
4263
|
#
|
4264
|
+
# @!attribute [rw] asset_composite_model_summaries
|
4265
|
+
# The list of the immediate child custom composite model summaries for
|
4266
|
+
# the asset.
|
4267
|
+
# @return [Array<Types::AssetCompositeModelSummary>]
|
4268
|
+
#
|
4269
|
+
# @!attribute [rw] asset_external_id
|
4270
|
+
# The external ID of the asset, if any.
|
4271
|
+
# @return [String]
|
4272
|
+
#
|
3031
4273
|
class DescribeAssetResponse < Struct.new(
|
3032
4274
|
:asset_id,
|
3033
4275
|
:asset_arn,
|
@@ -3039,7 +4281,9 @@ module Aws::IoTSiteWise
|
|
3039
4281
|
:asset_creation_date,
|
3040
4282
|
:asset_last_update_date,
|
3041
4283
|
:asset_status,
|
3042
|
-
:asset_description
|
4284
|
+
:asset_description,
|
4285
|
+
:asset_composite_model_summaries,
|
4286
|
+
:asset_external_id)
|
3043
4287
|
SENSITIVE = []
|
3044
4288
|
include Aws::Structure
|
3045
4289
|
end
|
@@ -3063,7 +4307,7 @@ module Aws::IoTSiteWise
|
|
3063
4307
|
# @return [String]
|
3064
4308
|
#
|
3065
4309
|
# @!attribute [rw] job_status
|
3066
|
-
# The status of the bulk import job can be one of following values
|
4310
|
+
# The status of the bulk import job can be one of following values:
|
3067
4311
|
#
|
3068
4312
|
# * `PENDING` – IoT SiteWise is waiting for the current bulk import
|
3069
4313
|
# job to finish.
|
@@ -3117,6 +4361,18 @@ module Aws::IoTSiteWise
|
|
3117
4361
|
# The date the job was last updated, in Unix epoch time.
|
3118
4362
|
# @return [Time]
|
3119
4363
|
#
|
4364
|
+
# @!attribute [rw] adaptive_ingestion
|
4365
|
+
# If set to true, ingest new data into IoT SiteWise storage.
|
4366
|
+
# Measurements with notifications, metrics and transforms are
|
4367
|
+
# computed. If set to false, historical data is ingested into IoT
|
4368
|
+
# SiteWise as is.
|
4369
|
+
# @return [Boolean]
|
4370
|
+
#
|
4371
|
+
# @!attribute [rw] delete_files_after_import
|
4372
|
+
# If set to true, your data files is deleted from S3, after ingestion
|
4373
|
+
# into IoT SiteWise storage.
|
4374
|
+
# @return [Boolean]
|
4375
|
+
#
|
3120
4376
|
class DescribeBulkImportJobResponse < Struct.new(
|
3121
4377
|
:job_id,
|
3122
4378
|
:job_name,
|
@@ -3126,7 +4382,9 @@ module Aws::IoTSiteWise
|
|
3126
4382
|
:error_report_location,
|
3127
4383
|
:job_configuration,
|
3128
4384
|
:job_creation_date,
|
3129
|
-
:job_last_update_date
|
4385
|
+
:job_last_update_date,
|
4386
|
+
:adaptive_ingestion,
|
4387
|
+
:delete_files_after_import)
|
3130
4388
|
SENSITIVE = []
|
3131
4389
|
include Aws::Structure
|
3132
4390
|
end
|
@@ -3393,8 +4651,9 @@ module Aws::IoTSiteWise
|
|
3393
4651
|
#
|
3394
4652
|
# @!attribute [rw] portal_client_id
|
3395
4653
|
# The IAM Identity Center application generated client ID (used with
|
3396
|
-
# IAM Identity Center
|
3397
|
-
# for only portals that use IAM Identity Center to
|
4654
|
+
# IAM Identity Center API operations). IoT SiteWise includes
|
4655
|
+
# `portalClientId` for only portals that use IAM Identity Center to
|
4656
|
+
# authenticate users.
|
3398
4657
|
# @return [String]
|
3399
4658
|
#
|
3400
4659
|
# @!attribute [rw] portal_start_url
|
@@ -3569,8 +4828,8 @@ module Aws::IoTSiteWise
|
|
3569
4828
|
# @return [String]
|
3570
4829
|
#
|
3571
4830
|
# @!attribute [rw] retention_period
|
3572
|
-
#
|
3573
|
-
# data is kept indefinitely in the hot tier.
|
4831
|
+
# The number of days your data is kept in the hot tier. By default,
|
4832
|
+
# your data is kept indefinitely in the hot tier.
|
3574
4833
|
# @return [Types::RetentionPeriod]
|
3575
4834
|
#
|
3576
4835
|
# @!attribute [rw] configuration_status
|
@@ -3582,13 +4841,27 @@ module Aws::IoTSiteWise
|
|
3582
4841
|
# time.
|
3583
4842
|
# @return [Time]
|
3584
4843
|
#
|
4844
|
+
# @!attribute [rw] warm_tier
|
4845
|
+
# A service managed storage tier optimized for analytical queries. It
|
4846
|
+
# stores periodically uploaded, buffered and historical data ingested
|
4847
|
+
# with the CreaeBulkImportJob API.
|
4848
|
+
# @return [String]
|
4849
|
+
#
|
4850
|
+
# @!attribute [rw] warm_tier_retention_period
|
4851
|
+
# Set this period to specify how long your data is stored in the warm
|
4852
|
+
# tier before it is deleted. You can set this only if cold tier is
|
4853
|
+
# enabled.
|
4854
|
+
# @return [Types::WarmTierRetentionPeriod]
|
4855
|
+
#
|
3585
4856
|
class DescribeStorageConfigurationResponse < Struct.new(
|
3586
4857
|
:storage_type,
|
3587
4858
|
:multi_layer_storage,
|
3588
4859
|
:disassociated_data_storage,
|
3589
4860
|
:retention_period,
|
3590
4861
|
:configuration_status,
|
3591
|
-
:last_update_date
|
4862
|
+
:last_update_date,
|
4863
|
+
:warm_tier,
|
4864
|
+
:warm_tier_retention_period)
|
3592
4865
|
SENSITIVE = []
|
3593
4866
|
include Aws::Structure
|
3594
4867
|
end
|
@@ -3598,11 +4871,26 @@ module Aws::IoTSiteWise
|
|
3598
4871
|
# @return [String]
|
3599
4872
|
#
|
3600
4873
|
# @!attribute [rw] asset_id
|
3601
|
-
# The ID of the asset in which the asset property was created.
|
4874
|
+
# The ID of the asset in which the asset property was created. This
|
4875
|
+
# can be either the actual ID in UUID format, or else `externalId:`
|
4876
|
+
# followed by the external ID, if it has one. For more information,
|
4877
|
+
# see [Referencing objects with external IDs][1] in the *IoT SiteWise
|
4878
|
+
# User Guide*.
|
4879
|
+
#
|
4880
|
+
#
|
4881
|
+
#
|
4882
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references
|
3602
4883
|
# @return [String]
|
3603
4884
|
#
|
3604
4885
|
# @!attribute [rw] property_id
|
3605
|
-
# The ID of the asset property.
|
4886
|
+
# The ID of the asset property. This can be either the actual ID in
|
4887
|
+
# UUID format, or else `externalId:` followed by the external ID, if
|
4888
|
+
# it has one. For more information, see [Referencing objects with
|
4889
|
+
# external IDs][1] in the *IoT SiteWise User Guide*.
|
4890
|
+
#
|
4891
|
+
#
|
4892
|
+
#
|
4893
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references
|
3606
4894
|
# @return [String]
|
3607
4895
|
#
|
3608
4896
|
class DescribeTimeSeriesRequest < Struct.new(
|
@@ -3618,7 +4906,7 @@ module Aws::IoTSiteWise
|
|
3618
4906
|
# @return [String]
|
3619
4907
|
#
|
3620
4908
|
# @!attribute [rw] property_id
|
3621
|
-
# The ID of the asset property.
|
4909
|
+
# The ID of the asset property, in UUID format.
|
3622
4910
|
# @return [String]
|
3623
4911
|
#
|
3624
4912
|
# @!attribute [rw] alias
|
@@ -3697,23 +4985,42 @@ module Aws::IoTSiteWise
|
|
3697
4985
|
|
3698
4986
|
# @!attribute [rw] asset_id
|
3699
4987
|
# The ID of the parent asset from which to disassociate the child
|
3700
|
-
# asset.
|
4988
|
+
# asset. This can be either the actual ID in UUID format, or else
|
4989
|
+
# `externalId:` followed by the external ID, if it has one. For more
|
4990
|
+
# information, see [Referencing objects with external IDs][1] in the
|
4991
|
+
# *IoT SiteWise User Guide*.
|
4992
|
+
#
|
4993
|
+
#
|
4994
|
+
#
|
4995
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references
|
3701
4996
|
# @return [String]
|
3702
4997
|
#
|
3703
4998
|
# @!attribute [rw] hierarchy_id
|
3704
|
-
# The ID of a hierarchy in the parent asset's model.
|
3705
|
-
#
|
3706
|
-
# the
|
3707
|
-
#
|
3708
|
-
#
|
4999
|
+
# The ID of a hierarchy in the parent asset's model. (This can be
|
5000
|
+
# either the actual ID in UUID format, or else `externalId:` followed
|
5001
|
+
# by the external ID, if it has one. For more information, see
|
5002
|
+
# [Referencing objects with external IDs][1] in the *IoT SiteWise User
|
5003
|
+
# Guide*.) Hierarchies allow different groupings of assets to be
|
5004
|
+
# formed that all come from the same asset model. You can use the
|
5005
|
+
# hierarchy ID to identify the correct asset to disassociate. For more
|
5006
|
+
# information, see [Asset hierarchies][2] in the *IoT SiteWise User
|
5007
|
+
# Guide*.
|
3709
5008
|
#
|
3710
5009
|
#
|
3711
5010
|
#
|
3712
|
-
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/
|
5011
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references
|
5012
|
+
# [2]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html
|
3713
5013
|
# @return [String]
|
3714
5014
|
#
|
3715
5015
|
# @!attribute [rw] child_asset_id
|
3716
|
-
# The ID of the child asset to disassociate.
|
5016
|
+
# The ID of the child asset to disassociate. This can be either the
|
5017
|
+
# actual ID in UUID format, or else `externalId:` followed by the
|
5018
|
+
# external ID, if it has one. For more information, see [Referencing
|
5019
|
+
# objects with external IDs][1] in the *IoT SiteWise User Guide*.
|
5020
|
+
#
|
5021
|
+
#
|
5022
|
+
#
|
5023
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references
|
3717
5024
|
# @return [String]
|
3718
5025
|
#
|
3719
5026
|
# @!attribute [rw] client_token
|
@@ -3739,11 +5046,26 @@ module Aws::IoTSiteWise
|
|
3739
5046
|
# @return [String]
|
3740
5047
|
#
|
3741
5048
|
# @!attribute [rw] asset_id
|
3742
|
-
# The ID of the asset in which the asset property was created.
|
5049
|
+
# The ID of the asset in which the asset property was created. This
|
5050
|
+
# can be either the actual ID in UUID format, or else `externalId:`
|
5051
|
+
# followed by the external ID, if it has one. For more information,
|
5052
|
+
# see [Referencing objects with external IDs][1] in the *IoT SiteWise
|
5053
|
+
# User Guide*.
|
5054
|
+
#
|
5055
|
+
#
|
5056
|
+
#
|
5057
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references
|
3743
5058
|
# @return [String]
|
3744
5059
|
#
|
3745
5060
|
# @!attribute [rw] property_id
|
3746
|
-
# The ID of the asset property.
|
5061
|
+
# The ID of the asset property. This can be either the actual ID in
|
5062
|
+
# UUID format, or else `externalId:` followed by the external ID, if
|
5063
|
+
# it has one. For more information, see [Referencing objects with
|
5064
|
+
# external IDs][1] in the *IoT SiteWise User Guide*.
|
5065
|
+
#
|
5066
|
+
#
|
5067
|
+
#
|
5068
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references
|
3747
5069
|
# @return [String]
|
3748
5070
|
#
|
3749
5071
|
# @!attribute [rw] client_token
|
@@ -3814,6 +5136,84 @@ module Aws::IoTSiteWise
|
|
3814
5136
|
include Aws::Structure
|
3815
5137
|
end
|
3816
5138
|
|
5139
|
+
# @!attribute [rw] target_resource
|
5140
|
+
# The resource the action will be taken on.
|
5141
|
+
# @return [Types::TargetResource]
|
5142
|
+
#
|
5143
|
+
# @!attribute [rw] action_definition_id
|
5144
|
+
# The ID of the action definition.
|
5145
|
+
# @return [String]
|
5146
|
+
#
|
5147
|
+
# @!attribute [rw] action_payload
|
5148
|
+
# The JSON payload of the action.
|
5149
|
+
# @return [Types::ActionPayload]
|
5150
|
+
#
|
5151
|
+
# @!attribute [rw] client_token
|
5152
|
+
# A unique case-sensitive identifier that you can provide to ensure
|
5153
|
+
# the idempotency of the request. Don't reuse this client token if a
|
5154
|
+
# new idempotent request is required.
|
5155
|
+
# @return [String]
|
5156
|
+
#
|
5157
|
+
class ExecuteActionRequest < Struct.new(
|
5158
|
+
:target_resource,
|
5159
|
+
:action_definition_id,
|
5160
|
+
:action_payload,
|
5161
|
+
:client_token)
|
5162
|
+
SENSITIVE = []
|
5163
|
+
include Aws::Structure
|
5164
|
+
end
|
5165
|
+
|
5166
|
+
# @!attribute [rw] action_id
|
5167
|
+
# The ID of the action.
|
5168
|
+
# @return [String]
|
5169
|
+
#
|
5170
|
+
class ExecuteActionResponse < Struct.new(
|
5171
|
+
:action_id)
|
5172
|
+
SENSITIVE = []
|
5173
|
+
include Aws::Structure
|
5174
|
+
end
|
5175
|
+
|
5176
|
+
# @!attribute [rw] query_statement
|
5177
|
+
# The IoT SiteWise query statement.
|
5178
|
+
# @return [String]
|
5179
|
+
#
|
5180
|
+
# @!attribute [rw] next_token
|
5181
|
+
# The string that specifies the next page of results.
|
5182
|
+
# @return [String]
|
5183
|
+
#
|
5184
|
+
# @!attribute [rw] max_results
|
5185
|
+
# The maximum number of results to return at one time. The default is
|
5186
|
+
# 25.
|
5187
|
+
# @return [Integer]
|
5188
|
+
#
|
5189
|
+
class ExecuteQueryRequest < Struct.new(
|
5190
|
+
:query_statement,
|
5191
|
+
:next_token,
|
5192
|
+
:max_results)
|
5193
|
+
SENSITIVE = []
|
5194
|
+
include Aws::Structure
|
5195
|
+
end
|
5196
|
+
|
5197
|
+
# @!attribute [rw] columns
|
5198
|
+
# Represents a single column in the query results.
|
5199
|
+
# @return [Array<Types::ColumnInfo>]
|
5200
|
+
#
|
5201
|
+
# @!attribute [rw] rows
|
5202
|
+
# Represents a single row in the query results.
|
5203
|
+
# @return [Array<Types::Row>]
|
5204
|
+
#
|
5205
|
+
# @!attribute [rw] next_token
|
5206
|
+
# The string that specifies the next page of results.
|
5207
|
+
# @return [String]
|
5208
|
+
#
|
5209
|
+
class ExecuteQueryResponse < Struct.new(
|
5210
|
+
:columns,
|
5211
|
+
:rows,
|
5212
|
+
:next_token)
|
5213
|
+
SENSITIVE = []
|
5214
|
+
include Aws::Structure
|
5215
|
+
end
|
5216
|
+
|
3817
5217
|
# Contains expression variable information.
|
3818
5218
|
#
|
3819
5219
|
# @!attribute [rw] name
|
@@ -3857,14 +5257,19 @@ module Aws::IoTSiteWise
|
|
3857
5257
|
include Aws::Structure
|
3858
5258
|
end
|
3859
5259
|
|
3860
|
-
# The file format of the data.
|
5260
|
+
# The file format of the data in S3.
|
3861
5261
|
#
|
3862
5262
|
# @!attribute [rw] csv
|
3863
|
-
# The .
|
5263
|
+
# The file is in .CSV format.
|
3864
5264
|
# @return [Types::Csv]
|
3865
5265
|
#
|
5266
|
+
# @!attribute [rw] parquet
|
5267
|
+
# The file is in parquet format.
|
5268
|
+
# @return [Types::Parquet]
|
5269
|
+
#
|
3866
5270
|
class FileFormat < Struct.new(
|
3867
|
-
:csv
|
5271
|
+
:csv,
|
5272
|
+
:parquet)
|
3868
5273
|
SENSITIVE = []
|
3869
5274
|
include Aws::Structure
|
3870
5275
|
end
|
@@ -3972,11 +5377,11 @@ module Aws::IoTSiteWise
|
|
3972
5377
|
end
|
3973
5378
|
|
3974
5379
|
# @!attribute [rw] asset_id
|
3975
|
-
# The ID of the asset.
|
5380
|
+
# The ID of the asset, in UUID format.
|
3976
5381
|
# @return [String]
|
3977
5382
|
#
|
3978
5383
|
# @!attribute [rw] property_id
|
3979
|
-
# The ID of the asset property.
|
5384
|
+
# The ID of the asset property, in UUID format.
|
3980
5385
|
# @return [String]
|
3981
5386
|
#
|
3982
5387
|
# @!attribute [rw] property_alias
|
@@ -4030,7 +5435,7 @@ module Aws::IoTSiteWise
|
|
4030
5435
|
# * The size of the result set is equal to 1 MB.
|
4031
5436
|
#
|
4032
5437
|
# * The number of data points in the result set is equal to the value
|
4033
|
-
# of `maxResults`. The maximum value of `maxResults` is
|
5438
|
+
# of `maxResults`. The maximum value of `maxResults` is 2500.
|
4034
5439
|
# @return [Integer]
|
4035
5440
|
#
|
4036
5441
|
class GetAssetPropertyAggregatesRequest < Struct.new(
|
@@ -4066,11 +5471,11 @@ module Aws::IoTSiteWise
|
|
4066
5471
|
end
|
4067
5472
|
|
4068
5473
|
# @!attribute [rw] asset_id
|
4069
|
-
# The ID of the asset.
|
5474
|
+
# The ID of the asset, in UUID format.
|
4070
5475
|
# @return [String]
|
4071
5476
|
#
|
4072
5477
|
# @!attribute [rw] property_id
|
4073
|
-
# The ID of the asset property.
|
5478
|
+
# The ID of the asset property, in UUID format.
|
4074
5479
|
# @return [String]
|
4075
5480
|
#
|
4076
5481
|
# @!attribute [rw] property_alias
|
@@ -4150,11 +5555,11 @@ module Aws::IoTSiteWise
|
|
4150
5555
|
end
|
4151
5556
|
|
4152
5557
|
# @!attribute [rw] asset_id
|
4153
|
-
# The ID of the asset.
|
5558
|
+
# The ID of the asset, in UUID format.
|
4154
5559
|
# @return [String]
|
4155
5560
|
#
|
4156
5561
|
# @!attribute [rw] property_id
|
4157
|
-
# The ID of the asset property.
|
5562
|
+
# The ID of the asset property, in UUID format.
|
4158
5563
|
# @return [String]
|
4159
5564
|
#
|
4160
5565
|
# @!attribute [rw] property_alias
|
@@ -4188,11 +5593,11 @@ module Aws::IoTSiteWise
|
|
4188
5593
|
end
|
4189
5594
|
|
4190
5595
|
# @!attribute [rw] asset_id
|
4191
|
-
# The ID of the asset.
|
5596
|
+
# The ID of the asset, in UUID format.
|
4192
5597
|
# @return [String]
|
4193
5598
|
#
|
4194
5599
|
# @!attribute [rw] property_id
|
4195
|
-
# The ID of the asset property.
|
5600
|
+
# The ID of the asset property, in UUID format.
|
4196
5601
|
# @return [String]
|
4197
5602
|
#
|
4198
5603
|
# @!attribute [rw] property_alias
|
@@ -4451,10 +5856,10 @@ module Aws::IoTSiteWise
|
|
4451
5856
|
|
4452
5857
|
# Contains an identity that can access an IoT SiteWise Monitor resource.
|
4453
5858
|
#
|
4454
|
-
# <note markdown="1"> Currently, you can't use Amazon Web Services
|
4455
|
-
# Identity Center identity IDs. You can find the IAM
|
4456
|
-
# identity IDs in the URL of user and group pages in the
|
4457
|
-
# Center console][1].
|
5859
|
+
# <note markdown="1"> Currently, you can't use Amazon Web Services API operations to
|
5860
|
+
# retrieve IAM Identity Center identity IDs. You can find the IAM
|
5861
|
+
# Identity Center identity IDs in the URL of user and group pages in the
|
5862
|
+
# [IAM Identity Center console][1].
|
4458
5863
|
#
|
4459
5864
|
# </note>
|
4460
5865
|
#
|
@@ -4592,7 +5997,7 @@ module Aws::IoTSiteWise
|
|
4592
5997
|
# format used to save data in Amazon S3.
|
4593
5998
|
#
|
4594
5999
|
# @!attribute [rw] file_format
|
4595
|
-
# The file format of the data in
|
6000
|
+
# The file format of the data in S3.
|
4596
6001
|
# @return [Types::FileFormat]
|
4597
6002
|
#
|
4598
6003
|
class JobConfiguration < Struct.new(
|
@@ -4601,7 +6006,7 @@ module Aws::IoTSiteWise
|
|
4601
6006
|
include Aws::Structure
|
4602
6007
|
end
|
4603
6008
|
|
4604
|
-
# Contains
|
6009
|
+
# Contains the job summary information.
|
4605
6010
|
#
|
4606
6011
|
# @!attribute [rw] id
|
4607
6012
|
# The ID of the job.
|
@@ -4612,7 +6017,7 @@ module Aws::IoTSiteWise
|
|
4612
6017
|
# @return [String]
|
4613
6018
|
#
|
4614
6019
|
# @!attribute [rw] status
|
4615
|
-
# The status of the bulk import job can be one of following values
|
6020
|
+
# The status of the bulk import job can be one of following values:
|
4616
6021
|
#
|
4617
6022
|
# * `PENDING` – IoT SiteWise is waiting for the current bulk import
|
4618
6023
|
# job to finish.
|
@@ -4675,24 +6080,115 @@ module Aws::IoTSiteWise
|
|
4675
6080
|
# `USER` or `GROUP` for `identityType`.
|
4676
6081
|
# @return [String]
|
4677
6082
|
#
|
4678
|
-
# @!attribute [rw] resource_type
|
4679
|
-
# The type of resource (portal or project). This parameter is required
|
4680
|
-
# if you specify `resourceId`.
|
4681
|
-
# @return [String]
|
6083
|
+
# @!attribute [rw] resource_type
|
6084
|
+
# The type of resource (portal or project). This parameter is required
|
6085
|
+
# if you specify `resourceId`.
|
6086
|
+
# @return [String]
|
6087
|
+
#
|
6088
|
+
# @!attribute [rw] resource_id
|
6089
|
+
# The ID of the resource. This parameter is required if you specify
|
6090
|
+
# `resourceType`.
|
6091
|
+
# @return [String]
|
6092
|
+
#
|
6093
|
+
# @!attribute [rw] iam_arn
|
6094
|
+
# The ARN of the IAM user. For more information, see [IAM ARNs][1] in
|
6095
|
+
# the *IAM User Guide*. This parameter is required if you specify
|
6096
|
+
# `IAM` for `identityType`.
|
6097
|
+
#
|
6098
|
+
#
|
6099
|
+
#
|
6100
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html
|
6101
|
+
# @return [String]
|
6102
|
+
#
|
6103
|
+
# @!attribute [rw] next_token
|
6104
|
+
# The token to be used for the next set of paginated results.
|
6105
|
+
# @return [String]
|
6106
|
+
#
|
6107
|
+
# @!attribute [rw] max_results
|
6108
|
+
# The maximum number of results to return for each paginated request.
|
6109
|
+
#
|
6110
|
+
# Default: 50
|
6111
|
+
# @return [Integer]
|
6112
|
+
#
|
6113
|
+
class ListAccessPoliciesRequest < Struct.new(
|
6114
|
+
:identity_type,
|
6115
|
+
:identity_id,
|
6116
|
+
:resource_type,
|
6117
|
+
:resource_id,
|
6118
|
+
:iam_arn,
|
6119
|
+
:next_token,
|
6120
|
+
:max_results)
|
6121
|
+
SENSITIVE = []
|
6122
|
+
include Aws::Structure
|
6123
|
+
end
|
6124
|
+
|
6125
|
+
# @!attribute [rw] access_policy_summaries
|
6126
|
+
# A list that summarizes each access policy.
|
6127
|
+
# @return [Array<Types::AccessPolicySummary>]
|
6128
|
+
#
|
6129
|
+
# @!attribute [rw] next_token
|
6130
|
+
# The token for the next set of results, or null if there are no
|
6131
|
+
# additional results.
|
6132
|
+
# @return [String]
|
6133
|
+
#
|
6134
|
+
class ListAccessPoliciesResponse < Struct.new(
|
6135
|
+
:access_policy_summaries,
|
6136
|
+
:next_token)
|
6137
|
+
SENSITIVE = []
|
6138
|
+
include Aws::Structure
|
6139
|
+
end
|
6140
|
+
|
6141
|
+
# @!attribute [rw] target_resource_type
|
6142
|
+
# The type of resource.
|
6143
|
+
# @return [String]
|
6144
|
+
#
|
6145
|
+
# @!attribute [rw] target_resource_id
|
6146
|
+
# The ID of the target resource.
|
6147
|
+
# @return [String]
|
6148
|
+
#
|
6149
|
+
# @!attribute [rw] next_token
|
6150
|
+
# The token to be used for the next set of paginated results.
|
6151
|
+
# @return [String]
|
6152
|
+
#
|
6153
|
+
# @!attribute [rw] max_results
|
6154
|
+
# The maximum number of results to return for each paginated request.
|
6155
|
+
# @return [Integer]
|
6156
|
+
#
|
6157
|
+
class ListActionsRequest < Struct.new(
|
6158
|
+
:target_resource_type,
|
6159
|
+
:target_resource_id,
|
6160
|
+
:next_token,
|
6161
|
+
:max_results)
|
6162
|
+
SENSITIVE = []
|
6163
|
+
include Aws::Structure
|
6164
|
+
end
|
6165
|
+
|
6166
|
+
# @!attribute [rw] action_summaries
|
6167
|
+
# A list that summarizes the actions associated with the specified
|
6168
|
+
# asset.
|
6169
|
+
# @return [Array<Types::ActionSummary>]
|
4682
6170
|
#
|
4683
|
-
# @!attribute [rw]
|
4684
|
-
# The
|
4685
|
-
#
|
6171
|
+
# @!attribute [rw] next_token
|
6172
|
+
# The token for the next set of results, or null if there are no
|
6173
|
+
# additional results.
|
4686
6174
|
# @return [String]
|
4687
6175
|
#
|
4688
|
-
|
4689
|
-
|
4690
|
-
|
4691
|
-
|
6176
|
+
class ListActionsResponse < Struct.new(
|
6177
|
+
:action_summaries,
|
6178
|
+
:next_token)
|
6179
|
+
SENSITIVE = []
|
6180
|
+
include Aws::Structure
|
6181
|
+
end
|
6182
|
+
|
6183
|
+
# @!attribute [rw] asset_model_id
|
6184
|
+
# The ID of the asset model. This can be either the actual ID in UUID
|
6185
|
+
# format, or else `externalId:` followed by the external ID, if it has
|
6186
|
+
# one. For more information, see [Referencing objects with external
|
6187
|
+
# IDs][1] in the *IoT SiteWise User Guide*.
|
4692
6188
|
#
|
4693
6189
|
#
|
4694
6190
|
#
|
4695
|
-
# [1]: https://docs.aws.amazon.com/
|
6191
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references
|
4696
6192
|
# @return [String]
|
4697
6193
|
#
|
4698
6194
|
# @!attribute [rw] next_token
|
@@ -4705,36 +6201,39 @@ module Aws::IoTSiteWise
|
|
4705
6201
|
# Default: 50
|
4706
6202
|
# @return [Integer]
|
4707
6203
|
#
|
4708
|
-
class
|
4709
|
-
:
|
4710
|
-
:identity_id,
|
4711
|
-
:resource_type,
|
4712
|
-
:resource_id,
|
4713
|
-
:iam_arn,
|
6204
|
+
class ListAssetModelCompositeModelsRequest < Struct.new(
|
6205
|
+
:asset_model_id,
|
4714
6206
|
:next_token,
|
4715
6207
|
:max_results)
|
4716
6208
|
SENSITIVE = []
|
4717
6209
|
include Aws::Structure
|
4718
6210
|
end
|
4719
6211
|
|
4720
|
-
# @!attribute [rw]
|
4721
|
-
# A list that summarizes each
|
4722
|
-
# @return [Array<Types::
|
6212
|
+
# @!attribute [rw] asset_model_composite_model_summaries
|
6213
|
+
# A list that summarizes each composite model.
|
6214
|
+
# @return [Array<Types::AssetModelCompositeModelSummary>]
|
4723
6215
|
#
|
4724
6216
|
# @!attribute [rw] next_token
|
4725
6217
|
# The token for the next set of results, or null if there are no
|
4726
6218
|
# additional results.
|
4727
6219
|
# @return [String]
|
4728
6220
|
#
|
4729
|
-
class
|
4730
|
-
:
|
6221
|
+
class ListAssetModelCompositeModelsResponse < Struct.new(
|
6222
|
+
:asset_model_composite_model_summaries,
|
4731
6223
|
:next_token)
|
4732
6224
|
SENSITIVE = []
|
4733
6225
|
include Aws::Structure
|
4734
6226
|
end
|
4735
6227
|
|
4736
6228
|
# @!attribute [rw] asset_model_id
|
4737
|
-
# The ID of the asset model.
|
6229
|
+
# The ID of the asset model. This can be either the actual ID in UUID
|
6230
|
+
# format, or else `externalId:` followed by the external ID, if it has
|
6231
|
+
# one. For more information, see [Referencing objects with external
|
6232
|
+
# IDs][1] in the *IoT SiteWise User Guide*.
|
6233
|
+
#
|
6234
|
+
#
|
6235
|
+
#
|
6236
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references
|
4738
6237
|
# @return [String]
|
4739
6238
|
#
|
4740
6239
|
# @!attribute [rw] next_token
|
@@ -4795,9 +6294,22 @@ module Aws::IoTSiteWise
|
|
4795
6294
|
# Default: 50
|
4796
6295
|
# @return [Integer]
|
4797
6296
|
#
|
6297
|
+
# @!attribute [rw] asset_model_types
|
6298
|
+
# The type of asset model.
|
6299
|
+
#
|
6300
|
+
# * **ASSET\_MODEL** – (default) An asset model that you can use to
|
6301
|
+
# create assets. Can't be included as a component in another asset
|
6302
|
+
# model.
|
6303
|
+
#
|
6304
|
+
# * **COMPONENT\_MODEL** – A reusable component that you can include
|
6305
|
+
# in the composite models of other asset models. You can't create
|
6306
|
+
# assets directly from this type of asset model.
|
6307
|
+
# @return [Array<String>]
|
6308
|
+
#
|
4798
6309
|
class ListAssetModelsRequest < Struct.new(
|
4799
6310
|
:next_token,
|
4800
|
-
:max_results
|
6311
|
+
:max_results,
|
6312
|
+
:asset_model_types)
|
4801
6313
|
SENSITIVE = []
|
4802
6314
|
include Aws::Structure
|
4803
6315
|
end
|
@@ -4819,7 +6331,14 @@ module Aws::IoTSiteWise
|
|
4819
6331
|
end
|
4820
6332
|
|
4821
6333
|
# @!attribute [rw] asset_id
|
4822
|
-
# The ID of the asset.
|
6334
|
+
# The ID of the asset. This can be either the actual ID in UUID
|
6335
|
+
# format, or else `externalId:` followed by the external ID, if it has
|
6336
|
+
# one. For more information, see [Referencing objects with external
|
6337
|
+
# IDs][1] in the *IoT SiteWise User Guide*.
|
6338
|
+
#
|
6339
|
+
#
|
6340
|
+
#
|
6341
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references
|
4823
6342
|
# @return [String]
|
4824
6343
|
#
|
4825
6344
|
# @!attribute [rw] next_token
|
@@ -4871,7 +6390,14 @@ module Aws::IoTSiteWise
|
|
4871
6390
|
end
|
4872
6391
|
|
4873
6392
|
# @!attribute [rw] asset_id
|
4874
|
-
# The ID of the asset.
|
6393
|
+
# The ID of the asset. This can be either the actual ID in UUID
|
6394
|
+
# format, or else `externalId:` followed by the external ID, if it has
|
6395
|
+
# one. For more information, see [Referencing objects with external
|
6396
|
+
# IDs][1] in the *IoT SiteWise User Guide*.
|
6397
|
+
#
|
6398
|
+
#
|
6399
|
+
#
|
6400
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references
|
4875
6401
|
# @return [String]
|
4876
6402
|
#
|
4877
6403
|
# @!attribute [rw] traversal_type
|
@@ -4931,7 +6457,15 @@ module Aws::IoTSiteWise
|
|
4931
6457
|
#
|
4932
6458
|
# @!attribute [rw] asset_model_id
|
4933
6459
|
# The ID of the asset model by which to filter the list of assets.
|
4934
|
-
# This parameter is required if you choose `ALL` for `filter`.
|
6460
|
+
# This parameter is required if you choose `ALL` for `filter`. This
|
6461
|
+
# can be either the actual ID in UUID format, or else `externalId:`
|
6462
|
+
# followed by the external ID, if it has one. For more information,
|
6463
|
+
# see [Referencing objects with external IDs][1] in the *IoT SiteWise
|
6464
|
+
# User Guide*.
|
6465
|
+
#
|
6466
|
+
#
|
6467
|
+
#
|
6468
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references
|
4935
6469
|
# @return [String]
|
4936
6470
|
#
|
4937
6471
|
# @!attribute [rw] filter
|
@@ -4973,23 +6507,35 @@ module Aws::IoTSiteWise
|
|
4973
6507
|
end
|
4974
6508
|
|
4975
6509
|
# @!attribute [rw] asset_id
|
4976
|
-
# The ID of the asset to query.
|
6510
|
+
# The ID of the asset to query. This can be either the actual ID in
|
6511
|
+
# UUID format, or else `externalId:` followed by the external ID, if
|
6512
|
+
# it has one. For more information, see [Referencing objects with
|
6513
|
+
# external IDs][1] in the *IoT SiteWise User Guide*.
|
6514
|
+
#
|
6515
|
+
#
|
6516
|
+
#
|
6517
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references
|
4977
6518
|
# @return [String]
|
4978
6519
|
#
|
4979
6520
|
# @!attribute [rw] hierarchy_id
|
4980
6521
|
# The ID of the hierarchy by which child assets are associated to the
|
4981
|
-
# asset.
|
4982
|
-
#
|
4983
|
-
#
|
4984
|
-
#
|
4985
|
-
#
|
6522
|
+
# asset. (This can be either the actual ID in UUID format, or else
|
6523
|
+
# `externalId:` followed by the external ID, if it has one. For more
|
6524
|
+
# information, see [Referencing objects with external IDs][1] in the
|
6525
|
+
# *IoT SiteWise User Guide*.) To find a hierarchy ID, use the
|
6526
|
+
# [DescribeAsset][2] or [DescribeAssetModel][3] operations. This
|
6527
|
+
# parameter is required if you choose `CHILD` for
|
6528
|
+
# `traversalDirection`.
|
6529
|
+
#
|
6530
|
+
# For more information, see [Asset hierarchies][4] in the *IoT
|
4986
6531
|
# SiteWise User Guide*.
|
4987
6532
|
#
|
4988
6533
|
#
|
4989
6534
|
#
|
4990
|
-
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/
|
4991
|
-
# [2]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/
|
4992
|
-
# [3]: https://docs.aws.amazon.com/iot-sitewise/latest/
|
6535
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references
|
6536
|
+
# [2]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAsset.html
|
6537
|
+
# [3]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAssetModel.html
|
6538
|
+
# [4]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html
|
4993
6539
|
# @return [String]
|
4994
6540
|
#
|
4995
6541
|
# @!attribute [rw] traversal_direction
|
@@ -5078,6 +6624,51 @@ module Aws::IoTSiteWise
|
|
5078
6624
|
include Aws::Structure
|
5079
6625
|
end
|
5080
6626
|
|
6627
|
+
# @!attribute [rw] asset_model_id
|
6628
|
+
# The ID of the asset model. This can be either the actual ID in UUID
|
6629
|
+
# format, or else `externalId:` followed by the external ID, if it has
|
6630
|
+
# one. For more information, see [Referencing objects with external
|
6631
|
+
# IDs][1] in the *IoT SiteWise User Guide*.
|
6632
|
+
#
|
6633
|
+
#
|
6634
|
+
#
|
6635
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references
|
6636
|
+
# @return [String]
|
6637
|
+
#
|
6638
|
+
# @!attribute [rw] next_token
|
6639
|
+
# The token to be used for the next set of paginated results.
|
6640
|
+
# @return [String]
|
6641
|
+
#
|
6642
|
+
# @!attribute [rw] max_results
|
6643
|
+
# The maximum number of results to return for each paginated request.
|
6644
|
+
#
|
6645
|
+
# Default: 50
|
6646
|
+
# @return [Integer]
|
6647
|
+
#
|
6648
|
+
class ListCompositionRelationshipsRequest < Struct.new(
|
6649
|
+
:asset_model_id,
|
6650
|
+
:next_token,
|
6651
|
+
:max_results)
|
6652
|
+
SENSITIVE = []
|
6653
|
+
include Aws::Structure
|
6654
|
+
end
|
6655
|
+
|
6656
|
+
# @!attribute [rw] composition_relationship_summaries
|
6657
|
+
# A list that summarizes each composition relationship.
|
6658
|
+
# @return [Array<Types::CompositionRelationshipSummary>]
|
6659
|
+
#
|
6660
|
+
# @!attribute [rw] next_token
|
6661
|
+
# The token for the next set of results, or null if there are no
|
6662
|
+
# additional results.
|
6663
|
+
# @return [String]
|
6664
|
+
#
|
6665
|
+
class ListCompositionRelationshipsResponse < Struct.new(
|
6666
|
+
:composition_relationship_summaries,
|
6667
|
+
:next_token)
|
6668
|
+
SENSITIVE = []
|
6669
|
+
include Aws::Structure
|
6670
|
+
end
|
6671
|
+
|
5081
6672
|
# @!attribute [rw] project_id
|
5082
6673
|
# The ID of the project.
|
5083
6674
|
# @return [String]
|
@@ -5298,7 +6889,15 @@ module Aws::IoTSiteWise
|
|
5298
6889
|
# @return [Integer]
|
5299
6890
|
#
|
5300
6891
|
# @!attribute [rw] asset_id
|
5301
|
-
# The ID of the asset in which the asset property was created.
|
6892
|
+
# The ID of the asset in which the asset property was created. This
|
6893
|
+
# can be either the actual ID in UUID format, or else `externalId:`
|
6894
|
+
# followed by the external ID, if it has one. For more information,
|
6895
|
+
# see [Referencing objects with external IDs][1] in the *IoT SiteWise
|
6896
|
+
# User Guide*.
|
6897
|
+
#
|
6898
|
+
#
|
6899
|
+
#
|
6900
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references
|
5302
6901
|
# @return [String]
|
5303
6902
|
#
|
5304
6903
|
# @!attribute [rw] alias_prefix
|
@@ -5501,6 +7100,12 @@ module Aws::IoTSiteWise
|
|
5501
7100
|
include Aws::Structure
|
5502
7101
|
end
|
5503
7102
|
|
7103
|
+
# A parquet file.
|
7104
|
+
#
|
7105
|
+
# @api private
|
7106
|
+
#
|
7107
|
+
class Parquet < Aws::EmptyStructure; end
|
7108
|
+
|
5504
7109
|
# Identifies an IoT SiteWise Monitor portal.
|
5505
7110
|
#
|
5506
7111
|
# @!attribute [rw] id
|
@@ -5676,6 +7281,19 @@ module Aws::IoTSiteWise
|
|
5676
7281
|
# type.
|
5677
7282
|
# @return [Types::PropertyType]
|
5678
7283
|
#
|
7284
|
+
# @!attribute [rw] path
|
7285
|
+
# The structured path to the property from the root of the asset.
|
7286
|
+
# @return [Array<Types::AssetPropertyPathSegment>]
|
7287
|
+
#
|
7288
|
+
# @!attribute [rw] external_id
|
7289
|
+
# The external ID of the asset property. For more information, see
|
7290
|
+
# [Using external IDs][1] in the *IoT SiteWise User Guide*.
|
7291
|
+
#
|
7292
|
+
#
|
7293
|
+
#
|
7294
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
|
7295
|
+
# @return [String]
|
7296
|
+
#
|
5679
7297
|
class Property < Struct.new(
|
5680
7298
|
:id,
|
5681
7299
|
:name,
|
@@ -5683,7 +7301,9 @@ module Aws::IoTSiteWise
|
|
5683
7301
|
:notification,
|
5684
7302
|
:data_type,
|
5685
7303
|
:unit,
|
5686
|
-
:type
|
7304
|
+
:type,
|
7305
|
+
:path,
|
7306
|
+
:external_id)
|
5687
7307
|
SENSITIVE = []
|
5688
7308
|
include Aws::Structure
|
5689
7309
|
end
|
@@ -5895,15 +7515,29 @@ module Aws::IoTSiteWise
|
|
5895
7515
|
# @return [String]
|
5896
7516
|
#
|
5897
7517
|
# @!attribute [rw] retention_period
|
5898
|
-
#
|
5899
|
-
# data is kept indefinitely in the hot tier.
|
7518
|
+
# The number of days your data is kept in the hot tier. By default,
|
7519
|
+
# your data is kept indefinitely in the hot tier.
|
5900
7520
|
# @return [Types::RetentionPeriod]
|
5901
7521
|
#
|
7522
|
+
# @!attribute [rw] warm_tier
|
7523
|
+
# A service managed storage tier optimized for analytical queries. It
|
7524
|
+
# stores periodically uploaded, buffered and historical data ingested
|
7525
|
+
# with the CreaeBulkImportJob API.
|
7526
|
+
# @return [String]
|
7527
|
+
#
|
7528
|
+
# @!attribute [rw] warm_tier_retention_period
|
7529
|
+
# Set this period to specify how long your data is stored in the warm
|
7530
|
+
# tier before it is deleted. You can set this only if cold tier is
|
7531
|
+
# enabled.
|
7532
|
+
# @return [Types::WarmTierRetentionPeriod]
|
7533
|
+
#
|
5902
7534
|
class PutStorageConfigurationRequest < Struct.new(
|
5903
7535
|
:storage_type,
|
5904
7536
|
:multi_layer_storage,
|
5905
7537
|
:disassociated_data_storage,
|
5906
|
-
:retention_period
|
7538
|
+
:retention_period,
|
7539
|
+
:warm_tier,
|
7540
|
+
:warm_tier_retention_period)
|
5907
7541
|
SENSITIVE = []
|
5908
7542
|
include Aws::Structure
|
5909
7543
|
end
|
@@ -5947,20 +7581,45 @@ module Aws::IoTSiteWise
|
|
5947
7581
|
# @return [String]
|
5948
7582
|
#
|
5949
7583
|
# @!attribute [rw] retention_period
|
5950
|
-
#
|
5951
|
-
# data is kept indefinitely in the hot tier.
|
7584
|
+
# The number of days your data is kept in the hot tier. By default,
|
7585
|
+
# your data is kept indefinitely in the hot tier.
|
5952
7586
|
# @return [Types::RetentionPeriod]
|
5953
7587
|
#
|
5954
7588
|
# @!attribute [rw] configuration_status
|
5955
7589
|
# Contains current status information for the configuration.
|
5956
7590
|
# @return [Types::ConfigurationStatus]
|
5957
7591
|
#
|
7592
|
+
# @!attribute [rw] warm_tier
|
7593
|
+
# A service managed storage tier optimized for analytical queries. It
|
7594
|
+
# stores periodically uploaded, buffered and historical data ingested
|
7595
|
+
# with the CreaeBulkImportJob API.
|
7596
|
+
# @return [String]
|
7597
|
+
#
|
7598
|
+
# @!attribute [rw] warm_tier_retention_period
|
7599
|
+
# Set this period to specify how long your data is stored in the warm
|
7600
|
+
# tier before it is deleted. You can set this only if cold tier is
|
7601
|
+
# enabled.
|
7602
|
+
# @return [Types::WarmTierRetentionPeriod]
|
7603
|
+
#
|
5958
7604
|
class PutStorageConfigurationResponse < Struct.new(
|
5959
7605
|
:storage_type,
|
5960
7606
|
:multi_layer_storage,
|
5961
7607
|
:disassociated_data_storage,
|
5962
7608
|
:retention_period,
|
5963
|
-
:configuration_status
|
7609
|
+
:configuration_status,
|
7610
|
+
:warm_tier,
|
7611
|
+
:warm_tier_retention_period)
|
7612
|
+
SENSITIVE = []
|
7613
|
+
include Aws::Structure
|
7614
|
+
end
|
7615
|
+
|
7616
|
+
# The query timed out.
|
7617
|
+
#
|
7618
|
+
# @!attribute [rw] message
|
7619
|
+
# @return [String]
|
7620
|
+
#
|
7621
|
+
class QueryTimeoutException < Struct.new(
|
7622
|
+
:message)
|
5964
7623
|
SENSITIVE = []
|
5965
7624
|
include Aws::Structure
|
5966
7625
|
end
|
@@ -6014,8 +7673,8 @@ module Aws::IoTSiteWise
|
|
6014
7673
|
include Aws::Structure
|
6015
7674
|
end
|
6016
7675
|
|
6017
|
-
#
|
6018
|
-
# is kept indefinitely in the hot tier.
|
7676
|
+
# The number of days your data is kept in the hot tier. By default, your
|
7677
|
+
# data is kept indefinitely in the hot tier.
|
6019
7678
|
#
|
6020
7679
|
# @!attribute [rw] number_of_days
|
6021
7680
|
# The number of days that your data is kept.
|
@@ -6042,6 +7701,18 @@ module Aws::IoTSiteWise
|
|
6042
7701
|
include Aws::Structure
|
6043
7702
|
end
|
6044
7703
|
|
7704
|
+
# Represents a single row in the query results.
|
7705
|
+
#
|
7706
|
+
# @!attribute [rw] data
|
7707
|
+
# List of data points in a single row of the result set.
|
7708
|
+
# @return [Array<Types::Datum>]
|
7709
|
+
#
|
7710
|
+
class Row < Struct.new(
|
7711
|
+
:data)
|
7712
|
+
SENSITIVE = []
|
7713
|
+
include Aws::Structure
|
7714
|
+
end
|
7715
|
+
|
6045
7716
|
# The requested service is unavailable.
|
6046
7717
|
#
|
6047
7718
|
# @!attribute [rw] message
|
@@ -6080,6 +7751,18 @@ module Aws::IoTSiteWise
|
|
6080
7751
|
|
6081
7752
|
class TagResourceResponse < Aws::EmptyStructure; end
|
6082
7753
|
|
7754
|
+
# The resource the action will be taken on.
|
7755
|
+
#
|
7756
|
+
# @!attribute [rw] asset_id
|
7757
|
+
# The ID of the asset, in UUID format.
|
7758
|
+
# @return [String]
|
7759
|
+
#
|
7760
|
+
class TargetResource < Struct.new(
|
7761
|
+
:asset_id)
|
7762
|
+
SENSITIVE = []
|
7763
|
+
include Aws::Structure
|
7764
|
+
end
|
7765
|
+
|
6083
7766
|
# Your request exceeded a rate limit. For example, you might have
|
6084
7767
|
# exceeded the number of IoT SiteWise assets that can be created per
|
6085
7768
|
# second, the allowed number of messages per second, and so on.
|
@@ -6125,7 +7808,7 @@ module Aws::IoTSiteWise
|
|
6125
7808
|
# @return [String]
|
6126
7809
|
#
|
6127
7810
|
# @!attribute [rw] property_id
|
6128
|
-
# The ID of the asset property.
|
7811
|
+
# The ID of the asset property, in UUID format.
|
6129
7812
|
# @return [String]
|
6130
7813
|
#
|
6131
7814
|
# @!attribute [rw] alias
|
@@ -6437,7 +8120,91 @@ module Aws::IoTSiteWise
|
|
6437
8120
|
class UpdateAccessPolicyResponse < Aws::EmptyStructure; end
|
6438
8121
|
|
6439
8122
|
# @!attribute [rw] asset_model_id
|
6440
|
-
# The ID of the asset model
|
8123
|
+
# The ID of the asset model, in UUID format.
|
8124
|
+
# @return [String]
|
8125
|
+
#
|
8126
|
+
# @!attribute [rw] asset_model_composite_model_id
|
8127
|
+
# The ID of a composite model on this asset model.
|
8128
|
+
# @return [String]
|
8129
|
+
#
|
8130
|
+
# @!attribute [rw] asset_model_composite_model_external_id
|
8131
|
+
# An external ID to assign to the asset model. You can only set the
|
8132
|
+
# external ID of the asset model if it wasn't set when it was
|
8133
|
+
# created, or you're setting it to the exact same thing as when it
|
8134
|
+
# was created.
|
8135
|
+
# @return [String]
|
8136
|
+
#
|
8137
|
+
# @!attribute [rw] asset_model_composite_model_description
|
8138
|
+
# A description for the composite model.
|
8139
|
+
# @return [String]
|
8140
|
+
#
|
8141
|
+
# @!attribute [rw] asset_model_composite_model_name
|
8142
|
+
# A unique, friendly name for the composite model.
|
8143
|
+
# @return [String]
|
8144
|
+
#
|
8145
|
+
# @!attribute [rw] client_token
|
8146
|
+
# A unique case-sensitive identifier that you can provide to ensure
|
8147
|
+
# the idempotency of the request. Don't reuse this client token if a
|
8148
|
+
# new idempotent request is required.
|
8149
|
+
#
|
8150
|
+
# **A suitable default value is auto-generated.** You should normally
|
8151
|
+
# not need to pass this option.
|
8152
|
+
# @return [String]
|
8153
|
+
#
|
8154
|
+
# @!attribute [rw] asset_model_composite_model_properties
|
8155
|
+
# The property definitions of the composite model. For more
|
8156
|
+
# information, see <LINK>.
|
8157
|
+
#
|
8158
|
+
# You can specify up to 200 properties per composite model. For more
|
8159
|
+
# information, see [Quotas][1] in the *IoT SiteWise User Guide*.
|
8160
|
+
#
|
8161
|
+
#
|
8162
|
+
#
|
8163
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html
|
8164
|
+
# @return [Array<Types::AssetModelProperty>]
|
8165
|
+
#
|
8166
|
+
class UpdateAssetModelCompositeModelRequest < Struct.new(
|
8167
|
+
:asset_model_id,
|
8168
|
+
:asset_model_composite_model_id,
|
8169
|
+
:asset_model_composite_model_external_id,
|
8170
|
+
:asset_model_composite_model_description,
|
8171
|
+
:asset_model_composite_model_name,
|
8172
|
+
:client_token,
|
8173
|
+
:asset_model_composite_model_properties)
|
8174
|
+
SENSITIVE = []
|
8175
|
+
include Aws::Structure
|
8176
|
+
end
|
8177
|
+
|
8178
|
+
# @!attribute [rw] asset_model_composite_model_path
|
8179
|
+
# The path to the composite model listing the parent composite models.
|
8180
|
+
# @return [Array<Types::AssetModelCompositeModelPathSegment>]
|
8181
|
+
#
|
8182
|
+
# @!attribute [rw] asset_model_status
|
8183
|
+
# Contains current status information for an asset model. For more
|
8184
|
+
# information, see [Asset and model states][1] in the *IoT SiteWise
|
8185
|
+
# User Guide*.
|
8186
|
+
#
|
8187
|
+
#
|
8188
|
+
#
|
8189
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-and-model-states.html
|
8190
|
+
# @return [Types::AssetModelStatus]
|
8191
|
+
#
|
8192
|
+
class UpdateAssetModelCompositeModelResponse < Struct.new(
|
8193
|
+
:asset_model_composite_model_path,
|
8194
|
+
:asset_model_status)
|
8195
|
+
SENSITIVE = []
|
8196
|
+
include Aws::Structure
|
8197
|
+
end
|
8198
|
+
|
8199
|
+
# @!attribute [rw] asset_model_id
|
8200
|
+
# The ID of the asset model to update. This can be either the actual
|
8201
|
+
# ID in UUID format, or else `externalId:` followed by the external
|
8202
|
+
# ID, if it has one. For more information, see [Referencing objects
|
8203
|
+
# with external IDs][1] in the *IoT SiteWise User Guide*.
|
8204
|
+
#
|
8205
|
+
#
|
8206
|
+
#
|
8207
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references
|
6441
8208
|
# @return [String]
|
6442
8209
|
#
|
6443
8210
|
# @!attribute [rw] asset_model_name
|
@@ -6478,11 +8245,22 @@ module Aws::IoTSiteWise
|
|
6478
8245
|
# @return [Array<Types::AssetModelHierarchy>]
|
6479
8246
|
#
|
6480
8247
|
# @!attribute [rw] asset_model_composite_models
|
6481
|
-
# The composite
|
6482
|
-
#
|
6483
|
-
#
|
6484
|
-
#
|
8248
|
+
# The composite models that are part of this asset model. It groups
|
8249
|
+
# properties (such as attributes, measurements, transforms, and
|
8250
|
+
# metrics) and child composite models that model parts of your
|
8251
|
+
# industrial equipment. Each composite model has a type that defines
|
8252
|
+
# the properties that the composite model supports. Use composite
|
6485
8253
|
# models to define alarms on this asset model.
|
8254
|
+
#
|
8255
|
+
# <note markdown="1"> When creating custom composite models, you need to use
|
8256
|
+
# [CreateAssetModelCompositeModel][1]. For more information, see
|
8257
|
+
# <LINK>.
|
8258
|
+
#
|
8259
|
+
# </note>
|
8260
|
+
#
|
8261
|
+
#
|
8262
|
+
#
|
8263
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModelCompositeModel.html
|
6486
8264
|
# @return [Array<Types::AssetModelCompositeModel>]
|
6487
8265
|
#
|
6488
8266
|
# @!attribute [rw] client_token
|
@@ -6494,6 +8272,17 @@ module Aws::IoTSiteWise
|
|
6494
8272
|
# not need to pass this option.
|
6495
8273
|
# @return [String]
|
6496
8274
|
#
|
8275
|
+
# @!attribute [rw] asset_model_external_id
|
8276
|
+
# An external ID to assign to the asset model. The asset model must
|
8277
|
+
# not already have an external ID. The external ID must be unique
|
8278
|
+
# within your Amazon Web Services account. For more information, see
|
8279
|
+
# [Using external IDs][1] in the *IoT SiteWise User Guide*.
|
8280
|
+
#
|
8281
|
+
#
|
8282
|
+
#
|
8283
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
|
8284
|
+
# @return [String]
|
8285
|
+
#
|
6497
8286
|
class UpdateAssetModelRequest < Struct.new(
|
6498
8287
|
:asset_model_id,
|
6499
8288
|
:asset_model_name,
|
@@ -6501,7 +8290,8 @@ module Aws::IoTSiteWise
|
|
6501
8290
|
:asset_model_properties,
|
6502
8291
|
:asset_model_hierarchies,
|
6503
8292
|
:asset_model_composite_models,
|
6504
|
-
:client_token
|
8293
|
+
:client_token,
|
8294
|
+
:asset_model_external_id)
|
6505
8295
|
SENSITIVE = []
|
6506
8296
|
include Aws::Structure
|
6507
8297
|
end
|
@@ -6518,11 +8308,25 @@ module Aws::IoTSiteWise
|
|
6518
8308
|
end
|
6519
8309
|
|
6520
8310
|
# @!attribute [rw] asset_id
|
6521
|
-
# The ID of the asset to be updated.
|
8311
|
+
# The ID of the asset to be updated. This can be either the actual ID
|
8312
|
+
# in UUID format, or else `externalId:` followed by the external ID,
|
8313
|
+
# if it has one. For more information, see [Referencing objects with
|
8314
|
+
# external IDs][1] in the *IoT SiteWise User Guide*.
|
8315
|
+
#
|
8316
|
+
#
|
8317
|
+
#
|
8318
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references
|
6522
8319
|
# @return [String]
|
6523
8320
|
#
|
6524
8321
|
# @!attribute [rw] property_id
|
6525
|
-
# The ID of the asset property to be updated.
|
8322
|
+
# The ID of the asset property to be updated. This can be either the
|
8323
|
+
# actual ID in UUID format, or else `externalId:` followed by the
|
8324
|
+
# external ID, if it has one. For more information, see [Referencing
|
8325
|
+
# objects with external IDs][1] in the *IoT SiteWise User Guide*.
|
8326
|
+
#
|
8327
|
+
#
|
8328
|
+
#
|
8329
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references
|
6526
8330
|
# @return [String]
|
6527
8331
|
#
|
6528
8332
|
# @!attribute [rw] property_alias
|
@@ -6581,7 +8385,14 @@ module Aws::IoTSiteWise
|
|
6581
8385
|
end
|
6582
8386
|
|
6583
8387
|
# @!attribute [rw] asset_id
|
6584
|
-
# The ID of the asset to update.
|
8388
|
+
# The ID of the asset to update. This can be either the actual ID in
|
8389
|
+
# UUID format, or else `externalId:` followed by the external ID, if
|
8390
|
+
# it has one. For more information, see [Referencing objects with
|
8391
|
+
# external IDs][1] in the *IoT SiteWise User Guide*.
|
8392
|
+
#
|
8393
|
+
#
|
8394
|
+
#
|
8395
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references
|
6585
8396
|
# @return [String]
|
6586
8397
|
#
|
6587
8398
|
# @!attribute [rw] asset_name
|
@@ -6601,11 +8412,23 @@ module Aws::IoTSiteWise
|
|
6601
8412
|
# A description for the asset.
|
6602
8413
|
# @return [String]
|
6603
8414
|
#
|
8415
|
+
# @!attribute [rw] asset_external_id
|
8416
|
+
# An external ID to assign to the asset. The asset must not already
|
8417
|
+
# have an external ID. The external ID must be unique within your
|
8418
|
+
# Amazon Web Services account. For more information, see [Using
|
8419
|
+
# external IDs][1] in the *IoT SiteWise User Guide*.
|
8420
|
+
#
|
8421
|
+
#
|
8422
|
+
#
|
8423
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
|
8424
|
+
# @return [String]
|
8425
|
+
#
|
6604
8426
|
class UpdateAssetRequest < Struct.new(
|
6605
8427
|
:asset_id,
|
6606
8428
|
:asset_name,
|
6607
8429
|
:client_token,
|
6608
|
-
:asset_description
|
8430
|
+
:asset_description,
|
8431
|
+
:asset_external_id)
|
6609
8432
|
SENSITIVE = []
|
6610
8433
|
include Aws::Structure
|
6611
8434
|
end
|
@@ -6867,31 +8690,58 @@ module Aws::IoTSiteWise
|
|
6867
8690
|
include Aws::Structure
|
6868
8691
|
end
|
6869
8692
|
|
8693
|
+
# The validation failed for this query.
|
8694
|
+
#
|
8695
|
+
# @!attribute [rw] message
|
8696
|
+
# @return [String]
|
8697
|
+
#
|
8698
|
+
class ValidationException < Struct.new(
|
8699
|
+
:message)
|
8700
|
+
SENSITIVE = []
|
8701
|
+
include Aws::Structure
|
8702
|
+
end
|
8703
|
+
|
6870
8704
|
# Identifies a property value used in an expression.
|
6871
8705
|
#
|
6872
8706
|
# @!attribute [rw] property_id
|
6873
8707
|
# The ID of the property to use as the variable. You can use the
|
6874
|
-
# property `name` if it's from the same asset model.
|
8708
|
+
# property `name` if it's from the same asset model. If the property
|
8709
|
+
# has an external ID, you can specify `externalId:` followed by the
|
8710
|
+
# external ID. For more information, see [Using external IDs][1] in
|
8711
|
+
# the *IoT SiteWise User Guide*.
|
8712
|
+
#
|
8713
|
+
#
|
8714
|
+
#
|
8715
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
|
6875
8716
|
# @return [String]
|
6876
8717
|
#
|
6877
8718
|
# @!attribute [rw] hierarchy_id
|
6878
8719
|
# The ID of the hierarchy to query for the property ID. You can use
|
6879
|
-
# the hierarchy's name instead of the hierarchy's ID.
|
8720
|
+
# the hierarchy's name instead of the hierarchy's ID. If the
|
8721
|
+
# hierarchy has an external ID, you can specify `externalId:` followed
|
8722
|
+
# by the external ID. For more information, see [Using external
|
8723
|
+
# IDs][1] in the *IoT SiteWise User Guide*.
|
6880
8724
|
#
|
6881
8725
|
# You use a hierarchy ID instead of a model ID because you can have
|
6882
8726
|
# several hierarchies using the same model and therefore the same
|
6883
8727
|
# `propertyId`. For example, you might have separately grouped assets
|
6884
8728
|
# that come from the same asset model. For more information, see
|
6885
|
-
# [Asset hierarchies][
|
8729
|
+
# [Asset hierarchies][2] in the *IoT SiteWise User Guide*.
|
6886
8730
|
#
|
6887
8731
|
#
|
6888
8732
|
#
|
6889
|
-
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/
|
8733
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
|
8734
|
+
# [2]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html
|
6890
8735
|
# @return [String]
|
6891
8736
|
#
|
8737
|
+
# @!attribute [rw] property_path
|
8738
|
+
# The path of the property.
|
8739
|
+
# @return [Array<Types::AssetModelPropertyPathSegment>]
|
8740
|
+
#
|
6892
8741
|
class VariableValue < Struct.new(
|
6893
8742
|
:property_id,
|
6894
|
-
:hierarchy_id
|
8743
|
+
:hierarchy_id,
|
8744
|
+
:property_path)
|
6895
8745
|
SENSITIVE = []
|
6896
8746
|
include Aws::Structure
|
6897
8747
|
end
|
@@ -6903,7 +8753,8 @@ module Aws::IoTSiteWise
|
|
6903
8753
|
# @return [String]
|
6904
8754
|
#
|
6905
8755
|
# @!attribute [rw] integer_value
|
6906
|
-
# Asset property data of type integer (
|
8756
|
+
# Asset property data of type integer (number that's greater than or
|
8757
|
+
# equal to zero).
|
6907
8758
|
# @return [Integer]
|
6908
8759
|
#
|
6909
8760
|
# @!attribute [rw] double_value
|
@@ -6923,5 +8774,24 @@ module Aws::IoTSiteWise
|
|
6923
8774
|
include Aws::Structure
|
6924
8775
|
end
|
6925
8776
|
|
8777
|
+
# Set this period to specify how long your data is stored in the warm
|
8778
|
+
# tier before it is deleted. You can set this only if cold tier is
|
8779
|
+
# enabled.
|
8780
|
+
#
|
8781
|
+
# @!attribute [rw] number_of_days
|
8782
|
+
# The number of days the data is stored in the warm tier.
|
8783
|
+
# @return [Integer]
|
8784
|
+
#
|
8785
|
+
# @!attribute [rw] unlimited
|
8786
|
+
# If set to true, the data is stored indefinitely in the warm tier.
|
8787
|
+
# @return [Boolean]
|
8788
|
+
#
|
8789
|
+
class WarmTierRetentionPeriod < Struct.new(
|
8790
|
+
:number_of_days,
|
8791
|
+
:unlimited)
|
8792
|
+
SENSITIVE = []
|
8793
|
+
include Aws::Structure
|
8794
|
+
end
|
8795
|
+
|
6926
8796
|
end
|
6927
8797
|
end
|