aws-sdk-iotsitewise 1.46.0 → 1.48.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +13 -1
- data/VERSION +1 -1
- data/lib/aws-sdk-iotsitewise/client.rb +171 -23
- data/lib/aws-sdk-iotsitewise/client_api.rb +98 -0
- data/lib/aws-sdk-iotsitewise/endpoint_provider.rb +35 -96
- data/lib/aws-sdk-iotsitewise/endpoints.rb +28 -0
- data/lib/aws-sdk-iotsitewise/plugins/endpoints.rb +4 -0
- data/lib/aws-sdk-iotsitewise/types.rb +258 -1874
- data/lib/aws-sdk-iotsitewise.rb +1 -1
- metadata +2 -2
@@ -18,8 +18,8 @@ module Aws::IoTSiteWise
|
|
18
18
|
# @return [String]
|
19
19
|
#
|
20
20
|
# @!attribute [rw] identity
|
21
|
-
# The identity (an
|
22
|
-
#
|
21
|
+
# The identity (an IAM Identity Center user, an IAM Identity Center
|
22
|
+
# group, or an IAM user).
|
23
23
|
# @return [Types::Identity]
|
24
24
|
#
|
25
25
|
# @!attribute [rw] resource
|
@@ -123,14 +123,6 @@ module Aws::IoTSiteWise
|
|
123
123
|
#
|
124
124
|
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/appguide/monitor-alarms.html
|
125
125
|
#
|
126
|
-
# @note When making an API call, you may pass Alarms
|
127
|
-
# data as a hash:
|
128
|
-
#
|
129
|
-
# {
|
130
|
-
# alarm_role_arn: "ARN", # required
|
131
|
-
# notification_lambda_arn: "ARN",
|
132
|
-
# }
|
133
|
-
#
|
134
126
|
# @!attribute [rw] alarm_role_arn
|
135
127
|
# The [ARN][1] of the IAM role that allows the alarm to perform
|
136
128
|
# actions and access Amazon Web Services resources and services, such
|
@@ -180,11 +172,16 @@ module Aws::IoTSiteWise
|
|
180
172
|
# The asset properties that this composite model defines.
|
181
173
|
# @return [Array<Types::AssetProperty>]
|
182
174
|
#
|
175
|
+
# @!attribute [rw] id
|
176
|
+
# The ID of the asset composite model.
|
177
|
+
# @return [String]
|
178
|
+
#
|
183
179
|
class AssetCompositeModel < Struct.new(
|
184
180
|
:name,
|
185
181
|
:description,
|
186
182
|
:type,
|
187
|
-
:properties
|
183
|
+
:properties,
|
184
|
+
:id)
|
188
185
|
SENSITIVE = []
|
189
186
|
include Aws::Structure
|
190
187
|
end
|
@@ -257,75 +254,6 @@ module Aws::IoTSiteWise
|
|
257
254
|
# object contains the asset property definitions that you define in the
|
258
255
|
# composite model.
|
259
256
|
#
|
260
|
-
# @note When making an API call, you may pass AssetModelCompositeModel
|
261
|
-
# data as a hash:
|
262
|
-
#
|
263
|
-
# {
|
264
|
-
# name: "Name", # required
|
265
|
-
# description: "Description",
|
266
|
-
# type: "Name", # required
|
267
|
-
# properties: [
|
268
|
-
# {
|
269
|
-
# id: "ID",
|
270
|
-
# name: "Name", # required
|
271
|
-
# data_type: "STRING", # required, accepts STRING, INTEGER, DOUBLE, BOOLEAN, STRUCT
|
272
|
-
# data_type_spec: "Name",
|
273
|
-
# unit: "PropertyUnit",
|
274
|
-
# type: { # required
|
275
|
-
# attribute: {
|
276
|
-
# default_value: "DefaultValue",
|
277
|
-
# },
|
278
|
-
# measurement: {
|
279
|
-
# processing_config: {
|
280
|
-
# forwarding_config: { # required
|
281
|
-
# state: "DISABLED", # required, accepts DISABLED, ENABLED
|
282
|
-
# },
|
283
|
-
# },
|
284
|
-
# },
|
285
|
-
# transform: {
|
286
|
-
# expression: "Expression", # required
|
287
|
-
# variables: [ # required
|
288
|
-
# {
|
289
|
-
# name: "VariableName", # required
|
290
|
-
# value: { # required
|
291
|
-
# property_id: "Macro", # required
|
292
|
-
# hierarchy_id: "Macro",
|
293
|
-
# },
|
294
|
-
# },
|
295
|
-
# ],
|
296
|
-
# processing_config: {
|
297
|
-
# compute_location: "EDGE", # required, accepts EDGE, CLOUD
|
298
|
-
# forwarding_config: {
|
299
|
-
# state: "DISABLED", # required, accepts DISABLED, ENABLED
|
300
|
-
# },
|
301
|
-
# },
|
302
|
-
# },
|
303
|
-
# metric: {
|
304
|
-
# expression: "Expression", # required
|
305
|
-
# variables: [ # required
|
306
|
-
# {
|
307
|
-
# name: "VariableName", # required
|
308
|
-
# value: { # required
|
309
|
-
# property_id: "Macro", # required
|
310
|
-
# hierarchy_id: "Macro",
|
311
|
-
# },
|
312
|
-
# },
|
313
|
-
# ],
|
314
|
-
# window: { # required
|
315
|
-
# tumbling: {
|
316
|
-
# interval: "Interval", # required
|
317
|
-
# offset: "Offset",
|
318
|
-
# },
|
319
|
-
# },
|
320
|
-
# processing_config: {
|
321
|
-
# compute_location: "EDGE", # required, accepts EDGE, CLOUD
|
322
|
-
# },
|
323
|
-
# },
|
324
|
-
# },
|
325
|
-
# },
|
326
|
-
# ],
|
327
|
-
# }
|
328
|
-
#
|
329
257
|
# @!attribute [rw] name
|
330
258
|
# The name of the composite model.
|
331
259
|
# @return [String]
|
@@ -343,11 +271,16 @@ module Aws::IoTSiteWise
|
|
343
271
|
# The asset property definitions for this composite model.
|
344
272
|
# @return [Array<Types::AssetModelProperty>]
|
345
273
|
#
|
274
|
+
# @!attribute [rw] id
|
275
|
+
# The ID of the asset model composite model.
|
276
|
+
# @return [String]
|
277
|
+
#
|
346
278
|
class AssetModelCompositeModel < Struct.new(
|
347
279
|
:name,
|
348
280
|
:description,
|
349
281
|
:type,
|
350
|
-
:properties
|
282
|
+
:properties,
|
283
|
+
:id)
|
351
284
|
SENSITIVE = []
|
352
285
|
include Aws::Structure
|
353
286
|
end
|
@@ -356,74 +289,6 @@ module Aws::IoTSiteWise
|
|
356
289
|
# composite model definition is applied to all assets created from the
|
357
290
|
# asset model.
|
358
291
|
#
|
359
|
-
# @note When making an API call, you may pass AssetModelCompositeModelDefinition
|
360
|
-
# data as a hash:
|
361
|
-
#
|
362
|
-
# {
|
363
|
-
# name: "Name", # required
|
364
|
-
# description: "Description",
|
365
|
-
# type: "Name", # required
|
366
|
-
# properties: [
|
367
|
-
# {
|
368
|
-
# name: "Name", # required
|
369
|
-
# data_type: "STRING", # required, accepts STRING, INTEGER, DOUBLE, BOOLEAN, STRUCT
|
370
|
-
# data_type_spec: "Name",
|
371
|
-
# unit: "PropertyUnit",
|
372
|
-
# type: { # required
|
373
|
-
# attribute: {
|
374
|
-
# default_value: "DefaultValue",
|
375
|
-
# },
|
376
|
-
# measurement: {
|
377
|
-
# processing_config: {
|
378
|
-
# forwarding_config: { # required
|
379
|
-
# state: "DISABLED", # required, accepts DISABLED, ENABLED
|
380
|
-
# },
|
381
|
-
# },
|
382
|
-
# },
|
383
|
-
# transform: {
|
384
|
-
# expression: "Expression", # required
|
385
|
-
# variables: [ # required
|
386
|
-
# {
|
387
|
-
# name: "VariableName", # required
|
388
|
-
# value: { # required
|
389
|
-
# property_id: "Macro", # required
|
390
|
-
# hierarchy_id: "Macro",
|
391
|
-
# },
|
392
|
-
# },
|
393
|
-
# ],
|
394
|
-
# processing_config: {
|
395
|
-
# compute_location: "EDGE", # required, accepts EDGE, CLOUD
|
396
|
-
# forwarding_config: {
|
397
|
-
# state: "DISABLED", # required, accepts DISABLED, ENABLED
|
398
|
-
# },
|
399
|
-
# },
|
400
|
-
# },
|
401
|
-
# metric: {
|
402
|
-
# expression: "Expression", # required
|
403
|
-
# variables: [ # required
|
404
|
-
# {
|
405
|
-
# name: "VariableName", # required
|
406
|
-
# value: { # required
|
407
|
-
# property_id: "Macro", # required
|
408
|
-
# hierarchy_id: "Macro",
|
409
|
-
# },
|
410
|
-
# },
|
411
|
-
# ],
|
412
|
-
# window: { # required
|
413
|
-
# tumbling: {
|
414
|
-
# interval: "Interval", # required
|
415
|
-
# offset: "Offset",
|
416
|
-
# },
|
417
|
-
# },
|
418
|
-
# processing_config: {
|
419
|
-
# compute_location: "EDGE", # required, accepts EDGE, CLOUD
|
420
|
-
# },
|
421
|
-
# },
|
422
|
-
# },
|
423
|
-
# },
|
424
|
-
# ],
|
425
|
-
# }
|
426
|
-
#
|
427
292
|
# @!attribute [rw] name
|
428
293
|
# The name of the composite model.
|
429
294
|
# @return [String]
|
@@ -454,15 +319,6 @@ module Aws::IoTSiteWise
|
|
454
319
|
# and child asset model ID that specifies the type of asset that can be
|
455
320
|
# in this hierarchy.
|
456
321
|
#
|
457
|
-
# @note When making an API call, you may pass AssetModelHierarchy
|
458
|
-
# data as a hash:
|
459
|
-
#
|
460
|
-
# {
|
461
|
-
# id: "ID",
|
462
|
-
# name: "Name", # required
|
463
|
-
# child_asset_model_id: "ID", # required
|
464
|
-
# }
|
465
|
-
#
|
466
322
|
# @!attribute [rw] id
|
467
323
|
# The ID of the asset model hierarchy. This ID is a `hierarchyId`.
|
468
324
|
# @return [String]
|
@@ -494,14 +350,6 @@ module Aws::IoTSiteWise
|
|
494
350
|
# asset model hierarchy determines the kind (or type) of asset that can
|
495
351
|
# belong to a hierarchy.
|
496
352
|
#
|
497
|
-
# @note When making an API call, you may pass AssetModelHierarchyDefinition
|
498
|
-
# data as a hash:
|
499
|
-
#
|
500
|
-
# {
|
501
|
-
# name: "Name", # required
|
502
|
-
# child_asset_model_id: "ID", # required
|
503
|
-
# }
|
504
|
-
#
|
505
353
|
# @!attribute [rw] name
|
506
354
|
# The name of the asset model hierarchy definition (as specified in
|
507
355
|
# the [CreateAssetModel][1] or [UpdateAssetModel][2] API operation).
|
@@ -525,68 +373,6 @@ module Aws::IoTSiteWise
|
|
525
373
|
|
526
374
|
# Contains information about an asset model property.
|
527
375
|
#
|
528
|
-
# @note When making an API call, you may pass AssetModelProperty
|
529
|
-
# data as a hash:
|
530
|
-
#
|
531
|
-
# {
|
532
|
-
# id: "ID",
|
533
|
-
# name: "Name", # required
|
534
|
-
# data_type: "STRING", # required, accepts STRING, INTEGER, DOUBLE, BOOLEAN, STRUCT
|
535
|
-
# data_type_spec: "Name",
|
536
|
-
# unit: "PropertyUnit",
|
537
|
-
# type: { # required
|
538
|
-
# attribute: {
|
539
|
-
# default_value: "DefaultValue",
|
540
|
-
# },
|
541
|
-
# measurement: {
|
542
|
-
# processing_config: {
|
543
|
-
# forwarding_config: { # required
|
544
|
-
# state: "DISABLED", # required, accepts DISABLED, ENABLED
|
545
|
-
# },
|
546
|
-
# },
|
547
|
-
# },
|
548
|
-
# transform: {
|
549
|
-
# expression: "Expression", # required
|
550
|
-
# variables: [ # required
|
551
|
-
# {
|
552
|
-
# name: "VariableName", # required
|
553
|
-
# value: { # required
|
554
|
-
# property_id: "Macro", # required
|
555
|
-
# hierarchy_id: "Macro",
|
556
|
-
# },
|
557
|
-
# },
|
558
|
-
# ],
|
559
|
-
# processing_config: {
|
560
|
-
# compute_location: "EDGE", # required, accepts EDGE, CLOUD
|
561
|
-
# forwarding_config: {
|
562
|
-
# state: "DISABLED", # required, accepts DISABLED, ENABLED
|
563
|
-
# },
|
564
|
-
# },
|
565
|
-
# },
|
566
|
-
# metric: {
|
567
|
-
# expression: "Expression", # required
|
568
|
-
# variables: [ # required
|
569
|
-
# {
|
570
|
-
# name: "VariableName", # required
|
571
|
-
# value: { # required
|
572
|
-
# property_id: "Macro", # required
|
573
|
-
# hierarchy_id: "Macro",
|
574
|
-
# },
|
575
|
-
# },
|
576
|
-
# ],
|
577
|
-
# window: { # required
|
578
|
-
# tumbling: {
|
579
|
-
# interval: "Interval", # required
|
580
|
-
# offset: "Offset",
|
581
|
-
# },
|
582
|
-
# },
|
583
|
-
# processing_config: {
|
584
|
-
# compute_location: "EDGE", # required, accepts EDGE, CLOUD
|
585
|
-
# },
|
586
|
-
# },
|
587
|
-
# },
|
588
|
-
# }
|
589
|
-
#
|
590
376
|
# @!attribute [rw] id
|
591
377
|
# The ID of the asset model property.
|
592
378
|
# @return [String]
|
@@ -626,67 +412,6 @@ module Aws::IoTSiteWise
|
|
626
412
|
# Contains an asset model property definition. This property definition
|
627
413
|
# is applied to all assets created from the asset model.
|
628
414
|
#
|
629
|
-
# @note When making an API call, you may pass AssetModelPropertyDefinition
|
630
|
-
# data as a hash:
|
631
|
-
#
|
632
|
-
# {
|
633
|
-
# name: "Name", # required
|
634
|
-
# data_type: "STRING", # required, accepts STRING, INTEGER, DOUBLE, BOOLEAN, STRUCT
|
635
|
-
# data_type_spec: "Name",
|
636
|
-
# unit: "PropertyUnit",
|
637
|
-
# type: { # required
|
638
|
-
# attribute: {
|
639
|
-
# default_value: "DefaultValue",
|
640
|
-
# },
|
641
|
-
# measurement: {
|
642
|
-
# processing_config: {
|
643
|
-
# forwarding_config: { # required
|
644
|
-
# state: "DISABLED", # required, accepts DISABLED, ENABLED
|
645
|
-
# },
|
646
|
-
# },
|
647
|
-
# },
|
648
|
-
# transform: {
|
649
|
-
# expression: "Expression", # required
|
650
|
-
# variables: [ # required
|
651
|
-
# {
|
652
|
-
# name: "VariableName", # required
|
653
|
-
# value: { # required
|
654
|
-
# property_id: "Macro", # required
|
655
|
-
# hierarchy_id: "Macro",
|
656
|
-
# },
|
657
|
-
# },
|
658
|
-
# ],
|
659
|
-
# processing_config: {
|
660
|
-
# compute_location: "EDGE", # required, accepts EDGE, CLOUD
|
661
|
-
# forwarding_config: {
|
662
|
-
# state: "DISABLED", # required, accepts DISABLED, ENABLED
|
663
|
-
# },
|
664
|
-
# },
|
665
|
-
# },
|
666
|
-
# metric: {
|
667
|
-
# expression: "Expression", # required
|
668
|
-
# variables: [ # required
|
669
|
-
# {
|
670
|
-
# name: "VariableName", # required
|
671
|
-
# value: { # required
|
672
|
-
# property_id: "Macro", # required
|
673
|
-
# hierarchy_id: "Macro",
|
674
|
-
# },
|
675
|
-
# },
|
676
|
-
# ],
|
677
|
-
# window: { # required
|
678
|
-
# tumbling: {
|
679
|
-
# interval: "Interval", # required
|
680
|
-
# offset: "Offset",
|
681
|
-
# },
|
682
|
-
# },
|
683
|
-
# processing_config: {
|
684
|
-
# compute_location: "EDGE", # required, accepts EDGE, CLOUD
|
685
|
-
# },
|
686
|
-
# },
|
687
|
-
# },
|
688
|
-
# }
|
689
|
-
#
|
690
415
|
# @!attribute [rw] name
|
691
416
|
# The name of the property definition.
|
692
417
|
# @return [String]
|
@@ -726,6 +451,51 @@ module Aws::IoTSiteWise
|
|
726
451
|
include Aws::Structure
|
727
452
|
end
|
728
453
|
|
454
|
+
# Contains a summary of a property associated with a model.
|
455
|
+
#
|
456
|
+
# @!attribute [rw] id
|
457
|
+
# The ID of the property.
|
458
|
+
# @return [String]
|
459
|
+
#
|
460
|
+
# @!attribute [rw] name
|
461
|
+
# The name of the property.
|
462
|
+
# @return [String]
|
463
|
+
#
|
464
|
+
# @!attribute [rw] data_type
|
465
|
+
# The data type of the property.
|
466
|
+
# @return [String]
|
467
|
+
#
|
468
|
+
# @!attribute [rw] data_type_spec
|
469
|
+
# The data type of the structure for this property. This parameter
|
470
|
+
# exists on properties that have the `STRUCT` data type.
|
471
|
+
# @return [String]
|
472
|
+
#
|
473
|
+
# @!attribute [rw] unit
|
474
|
+
# The unit (such as `Newtons` or `RPM`) of the property.
|
475
|
+
# @return [String]
|
476
|
+
#
|
477
|
+
# @!attribute [rw] type
|
478
|
+
# Contains a property type, which can be one of `attribute`,
|
479
|
+
# `measurement`, `metric`, or `transform`.
|
480
|
+
# @return [Types::PropertyType]
|
481
|
+
#
|
482
|
+
# @!attribute [rw] asset_model_composite_model_id
|
483
|
+
# The ID of the composite model that contains the asset model
|
484
|
+
# property.
|
485
|
+
# @return [String]
|
486
|
+
#
|
487
|
+
class AssetModelPropertySummary < Struct.new(
|
488
|
+
:id,
|
489
|
+
:name,
|
490
|
+
:data_type,
|
491
|
+
:data_type_spec,
|
492
|
+
:unit,
|
493
|
+
:type,
|
494
|
+
:asset_model_composite_model_id)
|
495
|
+
SENSITIVE = []
|
496
|
+
include Aws::Structure
|
497
|
+
end
|
498
|
+
|
729
499
|
# Contains current status information for an asset model. For more
|
730
500
|
# information, see [Asset and model states][1] in the *IoT SiteWise User
|
731
501
|
# Guide*.
|
@@ -853,24 +623,55 @@ module Aws::IoTSiteWise
|
|
853
623
|
include Aws::Structure
|
854
624
|
end
|
855
625
|
|
856
|
-
# Contains
|
626
|
+
# Contains a summary of a property associated with an asset.
|
627
|
+
#
|
628
|
+
# @!attribute [rw] id
|
629
|
+
# The ID of the property.
|
630
|
+
# @return [String]
|
631
|
+
#
|
632
|
+
# @!attribute [rw] alias
|
633
|
+
# The alias that identifies the property, such as an OPC-UA server
|
634
|
+
# data stream path (for example,
|
635
|
+
# `/company/windfarm/3/turbine/7/temperature`). For more information,
|
636
|
+
# see [Mapping industrial data streams to asset properties][1] in the
|
637
|
+
# *IoT SiteWise User Guide*.
|
857
638
|
#
|
858
|
-
#
|
859
|
-
#
|
860
|
-
#
|
861
|
-
#
|
862
|
-
#
|
863
|
-
#
|
864
|
-
#
|
865
|
-
#
|
866
|
-
#
|
867
|
-
#
|
868
|
-
#
|
869
|
-
#
|
870
|
-
#
|
871
|
-
#
|
872
|
-
#
|
873
|
-
#
|
639
|
+
#
|
640
|
+
#
|
641
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html
|
642
|
+
# @return [String]
|
643
|
+
#
|
644
|
+
# @!attribute [rw] unit
|
645
|
+
# The unit of measure (such as Newtons or RPM) of the asset property.
|
646
|
+
# @return [String]
|
647
|
+
#
|
648
|
+
# @!attribute [rw] notification
|
649
|
+
# Contains asset property value notification information. When the
|
650
|
+
# notification state is enabled, IoT SiteWise publishes property value
|
651
|
+
# updates to a unique MQTT topic. For more information, see
|
652
|
+
# [Interacting with other services][1] in the *IoT SiteWise User
|
653
|
+
# Guide*.
|
654
|
+
#
|
655
|
+
#
|
656
|
+
#
|
657
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/interact-with-other-services.html
|
658
|
+
# @return [Types::PropertyNotification]
|
659
|
+
#
|
660
|
+
# @!attribute [rw] asset_composite_model_id
|
661
|
+
# The ID of the composite model that contains the asset property.
|
662
|
+
# @return [String]
|
663
|
+
#
|
664
|
+
class AssetPropertySummary < Struct.new(
|
665
|
+
:id,
|
666
|
+
:alias,
|
667
|
+
:unit,
|
668
|
+
:notification,
|
669
|
+
:asset_composite_model_id)
|
670
|
+
SENSITIVE = []
|
671
|
+
include Aws::Structure
|
672
|
+
end
|
673
|
+
|
674
|
+
# Contains asset property value information.
|
874
675
|
#
|
875
676
|
# @!attribute [rw] value
|
876
677
|
# The value of the asset property (see `Variant`).
|
@@ -1000,16 +801,6 @@ module Aws::IoTSiteWise
|
|
1000
801
|
include Aws::Structure
|
1001
802
|
end
|
1002
803
|
|
1003
|
-
# @note When making an API call, you may pass AssociateAssetsRequest
|
1004
|
-
# data as a hash:
|
1005
|
-
#
|
1006
|
-
# {
|
1007
|
-
# asset_id: "ID", # required
|
1008
|
-
# hierarchy_id: "ID", # required
|
1009
|
-
# child_asset_id: "ID", # required
|
1010
|
-
# client_token: "ClientToken",
|
1011
|
-
# }
|
1012
|
-
#
|
1013
804
|
# @!attribute [rw] asset_id
|
1014
805
|
# The ID of the parent asset.
|
1015
806
|
# @return [String]
|
@@ -1047,16 +838,6 @@ module Aws::IoTSiteWise
|
|
1047
838
|
include Aws::Structure
|
1048
839
|
end
|
1049
840
|
|
1050
|
-
# @note When making an API call, you may pass AssociateTimeSeriesToAssetPropertyRequest
|
1051
|
-
# data as a hash:
|
1052
|
-
#
|
1053
|
-
# {
|
1054
|
-
# alias: "PropertyAlias", # required
|
1055
|
-
# asset_id: "ID", # required
|
1056
|
-
# property_id: "ID", # required
|
1057
|
-
# client_token: "ClientToken",
|
1058
|
-
# }
|
1059
|
-
#
|
1060
841
|
# @!attribute [rw] alias
|
1061
842
|
# The alias that identifies the time series.
|
1062
843
|
# @return [String]
|
@@ -1153,13 +934,6 @@ module Aws::IoTSiteWise
|
|
1153
934
|
#
|
1154
935
|
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html#attributes
|
1155
936
|
#
|
1156
|
-
# @note When making an API call, you may pass Attribute
|
1157
|
-
# data as a hash:
|
1158
|
-
#
|
1159
|
-
# {
|
1160
|
-
# default_value: "DefaultValue",
|
1161
|
-
# }
|
1162
|
-
#
|
1163
937
|
# @!attribute [rw] default_value
|
1164
938
|
# The default value of the asset model property attribute. All assets
|
1165
939
|
# that you create from the asset model contain this attribute value.
|
@@ -1178,15 +952,6 @@ module Aws::IoTSiteWise
|
|
1178
952
|
include Aws::Structure
|
1179
953
|
end
|
1180
954
|
|
1181
|
-
# @note When making an API call, you may pass BatchAssociateProjectAssetsRequest
|
1182
|
-
# data as a hash:
|
1183
|
-
#
|
1184
|
-
# {
|
1185
|
-
# project_id: "ID", # required
|
1186
|
-
# asset_ids: ["ID"], # required
|
1187
|
-
# client_token: "ClientToken",
|
1188
|
-
# }
|
1189
|
-
#
|
1190
955
|
# @!attribute [rw] project_id
|
1191
956
|
# The ID of the project to which to associate the assets.
|
1192
957
|
# @return [String]
|
@@ -1222,15 +987,6 @@ module Aws::IoTSiteWise
|
|
1222
987
|
include Aws::Structure
|
1223
988
|
end
|
1224
989
|
|
1225
|
-
# @note When making an API call, you may pass BatchDisassociateProjectAssetsRequest
|
1226
|
-
# data as a hash:
|
1227
|
-
#
|
1228
|
-
# {
|
1229
|
-
# project_id: "ID", # required
|
1230
|
-
# asset_ids: ["ID"], # required
|
1231
|
-
# client_token: "ClientToken",
|
1232
|
-
# }
|
1233
|
-
#
|
1234
990
|
# @!attribute [rw] project_id
|
1235
991
|
# The ID of the project from which to disassociate the assets.
|
1236
992
|
# @return [String]
|
@@ -1282,22 +1038,6 @@ module Aws::IoTSiteWise
|
|
1282
1038
|
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html
|
1283
1039
|
# [2]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html
|
1284
1040
|
#
|
1285
|
-
# @note When making an API call, you may pass BatchGetAssetPropertyAggregatesEntry
|
1286
|
-
# data as a hash:
|
1287
|
-
#
|
1288
|
-
# {
|
1289
|
-
# entry_id: "EntryId", # required
|
1290
|
-
# asset_id: "ID",
|
1291
|
-
# property_id: "ID",
|
1292
|
-
# property_alias: "AssetPropertyAlias",
|
1293
|
-
# aggregate_types: ["AVERAGE"], # required, accepts AVERAGE, COUNT, MAXIMUM, MINIMUM, SUM, STANDARD_DEVIATION
|
1294
|
-
# resolution: "Resolution", # required
|
1295
|
-
# start_date: Time.now, # required
|
1296
|
-
# end_date: Time.now, # required
|
1297
|
-
# qualities: ["GOOD"], # accepts GOOD, BAD, UNCERTAIN
|
1298
|
-
# time_ordering: "ASCENDING", # accepts ASCENDING, DESCENDING
|
1299
|
-
# }
|
1300
|
-
#
|
1301
1041
|
# @!attribute [rw] entry_id
|
1302
1042
|
# The ID of the entry.
|
1303
1043
|
# @return [String]
|
@@ -1415,28 +1155,6 @@ module Aws::IoTSiteWise
|
|
1415
1155
|
include Aws::Structure
|
1416
1156
|
end
|
1417
1157
|
|
1418
|
-
# @note When making an API call, you may pass BatchGetAssetPropertyAggregatesRequest
|
1419
|
-
# data as a hash:
|
1420
|
-
#
|
1421
|
-
# {
|
1422
|
-
# entries: [ # required
|
1423
|
-
# {
|
1424
|
-
# entry_id: "EntryId", # required
|
1425
|
-
# asset_id: "ID",
|
1426
|
-
# property_id: "ID",
|
1427
|
-
# property_alias: "AssetPropertyAlias",
|
1428
|
-
# aggregate_types: ["AVERAGE"], # required, accepts AVERAGE, COUNT, MAXIMUM, MINIMUM, SUM, STANDARD_DEVIATION
|
1429
|
-
# resolution: "Resolution", # required
|
1430
|
-
# start_date: Time.now, # required
|
1431
|
-
# end_date: Time.now, # required
|
1432
|
-
# qualities: ["GOOD"], # accepts GOOD, BAD, UNCERTAIN
|
1433
|
-
# time_ordering: "ASCENDING", # accepts ASCENDING, DESCENDING
|
1434
|
-
# },
|
1435
|
-
# ],
|
1436
|
-
# next_token: "NextToken",
|
1437
|
-
# max_results: 1,
|
1438
|
-
# }
|
1439
|
-
#
|
1440
1158
|
# @!attribute [rw] entries
|
1441
1159
|
# The list of asset property aggregate entries for the batch get
|
1442
1160
|
# request. You can specify up to 16 entries per request.
|
@@ -1567,16 +1285,6 @@ module Aws::IoTSiteWise
|
|
1567
1285
|
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html
|
1568
1286
|
# [2]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html
|
1569
1287
|
#
|
1570
|
-
# @note When making an API call, you may pass BatchGetAssetPropertyValueEntry
|
1571
|
-
# data as a hash:
|
1572
|
-
#
|
1573
|
-
# {
|
1574
|
-
# entry_id: "EntryId", # required
|
1575
|
-
# asset_id: "ID",
|
1576
|
-
# property_id: "ID",
|
1577
|
-
# property_alias: "AssetPropertyAlias",
|
1578
|
-
# }
|
1579
|
-
#
|
1580
1288
|
# @!attribute [rw] entry_id
|
1581
1289
|
# The ID of the entry.
|
1582
1290
|
# @return [String]
|
@@ -1670,20 +1378,6 @@ module Aws::IoTSiteWise
|
|
1670
1378
|
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html
|
1671
1379
|
# [2]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html
|
1672
1380
|
#
|
1673
|
-
# @note When making an API call, you may pass BatchGetAssetPropertyValueHistoryEntry
|
1674
|
-
# data as a hash:
|
1675
|
-
#
|
1676
|
-
# {
|
1677
|
-
# entry_id: "EntryId", # required
|
1678
|
-
# asset_id: "ID",
|
1679
|
-
# property_id: "ID",
|
1680
|
-
# property_alias: "AssetPropertyAlias",
|
1681
|
-
# start_date: Time.now,
|
1682
|
-
# end_date: Time.now,
|
1683
|
-
# qualities: ["GOOD"], # accepts GOOD, BAD, UNCERTAIN
|
1684
|
-
# time_ordering: "ASCENDING", # accepts ASCENDING, DESCENDING
|
1685
|
-
# }
|
1686
|
-
#
|
1687
1381
|
# @!attribute [rw] entry_id
|
1688
1382
|
# The ID of the entry.
|
1689
1383
|
# @return [String]
|
@@ -1781,26 +1475,6 @@ module Aws::IoTSiteWise
|
|
1781
1475
|
include Aws::Structure
|
1782
1476
|
end
|
1783
1477
|
|
1784
|
-
# @note When making an API call, you may pass BatchGetAssetPropertyValueHistoryRequest
|
1785
|
-
# data as a hash:
|
1786
|
-
#
|
1787
|
-
# {
|
1788
|
-
# entries: [ # required
|
1789
|
-
# {
|
1790
|
-
# entry_id: "EntryId", # required
|
1791
|
-
# asset_id: "ID",
|
1792
|
-
# property_id: "ID",
|
1793
|
-
# property_alias: "AssetPropertyAlias",
|
1794
|
-
# start_date: Time.now,
|
1795
|
-
# end_date: Time.now,
|
1796
|
-
# qualities: ["GOOD"], # accepts GOOD, BAD, UNCERTAIN
|
1797
|
-
# time_ordering: "ASCENDING", # accepts ASCENDING, DESCENDING
|
1798
|
-
# },
|
1799
|
-
# ],
|
1800
|
-
# next_token: "NextToken",
|
1801
|
-
# max_results: 1,
|
1802
|
-
# }
|
1803
|
-
#
|
1804
1478
|
# @!attribute [rw] entries
|
1805
1479
|
# The list of asset property historical value entries for the batch
|
1806
1480
|
# get request. You can specify up to 16 entries per request.
|
@@ -1914,21 +1588,6 @@ module Aws::IoTSiteWise
|
|
1914
1588
|
include Aws::Structure
|
1915
1589
|
end
|
1916
1590
|
|
1917
|
-
# @note When making an API call, you may pass BatchGetAssetPropertyValueRequest
|
1918
|
-
# data as a hash:
|
1919
|
-
#
|
1920
|
-
# {
|
1921
|
-
# entries: [ # required
|
1922
|
-
# {
|
1923
|
-
# entry_id: "EntryId", # required
|
1924
|
-
# asset_id: "ID",
|
1925
|
-
# property_id: "ID",
|
1926
|
-
# property_alias: "AssetPropertyAlias",
|
1927
|
-
# },
|
1928
|
-
# ],
|
1929
|
-
# next_token: "NextToken",
|
1930
|
-
# }
|
1931
|
-
#
|
1932
1591
|
# @!attribute [rw] entries
|
1933
1592
|
# The list of asset property value entries for the batch get request.
|
1934
1593
|
# You can specify up to 16 entries per request.
|
@@ -2076,35 +1735,6 @@ module Aws::IoTSiteWise
|
|
2076
1735
|
include Aws::Structure
|
2077
1736
|
end
|
2078
1737
|
|
2079
|
-
# @note When making an API call, you may pass BatchPutAssetPropertyValueRequest
|
2080
|
-
# data as a hash:
|
2081
|
-
#
|
2082
|
-
# {
|
2083
|
-
# entries: [ # required
|
2084
|
-
# {
|
2085
|
-
# entry_id: "EntryId", # required
|
2086
|
-
# asset_id: "ID",
|
2087
|
-
# property_id: "ID",
|
2088
|
-
# property_alias: "AssetPropertyAlias",
|
2089
|
-
# property_values: [ # required
|
2090
|
-
# {
|
2091
|
-
# value: { # required
|
2092
|
-
# string_value: "PropertyValueStringValue",
|
2093
|
-
# integer_value: 1,
|
2094
|
-
# double_value: 1.0,
|
2095
|
-
# boolean_value: false,
|
2096
|
-
# },
|
2097
|
-
# timestamp: { # required
|
2098
|
-
# time_in_seconds: 1, # required
|
2099
|
-
# offset_in_nanos: 1,
|
2100
|
-
# },
|
2101
|
-
# quality: "GOOD", # accepts GOOD, BAD, UNCERTAIN
|
2102
|
-
# },
|
2103
|
-
# ],
|
2104
|
-
# },
|
2105
|
-
# ],
|
2106
|
-
# }
|
2107
|
-
#
|
2108
1738
|
# @!attribute [rw] entries
|
2109
1739
|
# The list of asset property value entries for the batch put request.
|
2110
1740
|
# You can specify up to 10 entries per request.
|
@@ -2141,10 +1771,15 @@ module Aws::IoTSiteWise
|
|
2141
1771
|
# Contains asset property information.
|
2142
1772
|
# @return [Types::Property]
|
2143
1773
|
#
|
1774
|
+
# @!attribute [rw] id
|
1775
|
+
# The ID of the composite model that contains the property.
|
1776
|
+
# @return [String]
|
1777
|
+
#
|
2144
1778
|
class CompositeModelProperty < Struct.new(
|
2145
1779
|
:name,
|
2146
1780
|
:type,
|
2147
|
-
:asset_property
|
1781
|
+
:asset_property,
|
1782
|
+
:id)
|
2148
1783
|
SENSITIVE = []
|
2149
1784
|
include Aws::Structure
|
2150
1785
|
end
|
@@ -2206,42 +1841,9 @@ module Aws::IoTSiteWise
|
|
2206
1841
|
include Aws::Structure
|
2207
1842
|
end
|
2208
1843
|
|
2209
|
-
# @note When making an API call, you may pass CreateAccessPolicyRequest
|
2210
|
-
# data as a hash:
|
2211
|
-
#
|
2212
|
-
# {
|
2213
|
-
# access_policy_identity: { # required
|
2214
|
-
# user: {
|
2215
|
-
# id: "IdentityId", # required
|
2216
|
-
# },
|
2217
|
-
# group: {
|
2218
|
-
# id: "IdentityId", # required
|
2219
|
-
# },
|
2220
|
-
# iam_user: {
|
2221
|
-
# arn: "ARN", # required
|
2222
|
-
# },
|
2223
|
-
# iam_role: {
|
2224
|
-
# arn: "ARN", # required
|
2225
|
-
# },
|
2226
|
-
# },
|
2227
|
-
# access_policy_resource: { # required
|
2228
|
-
# portal: {
|
2229
|
-
# id: "ID", # required
|
2230
|
-
# },
|
2231
|
-
# project: {
|
2232
|
-
# id: "ID", # required
|
2233
|
-
# },
|
2234
|
-
# },
|
2235
|
-
# access_policy_permission: "ADMINISTRATOR", # required, accepts ADMINISTRATOR, VIEWER
|
2236
|
-
# client_token: "ClientToken",
|
2237
|
-
# tags: {
|
2238
|
-
# "TagKey" => "TagValue",
|
2239
|
-
# },
|
2240
|
-
# }
|
2241
|
-
#
|
2242
1844
|
# @!attribute [rw] access_policy_identity
|
2243
|
-
# The identity for this access policy. Choose an
|
2244
|
-
#
|
1845
|
+
# The identity for this access policy. Choose an IAM Identity Center
|
1846
|
+
# user, an IAM Identity Center group, or an IAM user.
|
2245
1847
|
# @return [Types::Identity]
|
2246
1848
|
#
|
2247
1849
|
# @!attribute [rw] access_policy_resource
|
@@ -2304,149 +1906,6 @@ module Aws::IoTSiteWise
|
|
2304
1906
|
include Aws::Structure
|
2305
1907
|
end
|
2306
1908
|
|
2307
|
-
# @note When making an API call, you may pass CreateAssetModelRequest
|
2308
|
-
# data as a hash:
|
2309
|
-
#
|
2310
|
-
# {
|
2311
|
-
# asset_model_name: "Name", # required
|
2312
|
-
# asset_model_description: "Description",
|
2313
|
-
# asset_model_properties: [
|
2314
|
-
# {
|
2315
|
-
# name: "Name", # required
|
2316
|
-
# data_type: "STRING", # required, accepts STRING, INTEGER, DOUBLE, BOOLEAN, STRUCT
|
2317
|
-
# data_type_spec: "Name",
|
2318
|
-
# unit: "PropertyUnit",
|
2319
|
-
# type: { # required
|
2320
|
-
# attribute: {
|
2321
|
-
# default_value: "DefaultValue",
|
2322
|
-
# },
|
2323
|
-
# measurement: {
|
2324
|
-
# processing_config: {
|
2325
|
-
# forwarding_config: { # required
|
2326
|
-
# state: "DISABLED", # required, accepts DISABLED, ENABLED
|
2327
|
-
# },
|
2328
|
-
# },
|
2329
|
-
# },
|
2330
|
-
# transform: {
|
2331
|
-
# expression: "Expression", # required
|
2332
|
-
# variables: [ # required
|
2333
|
-
# {
|
2334
|
-
# name: "VariableName", # required
|
2335
|
-
# value: { # required
|
2336
|
-
# property_id: "Macro", # required
|
2337
|
-
# hierarchy_id: "Macro",
|
2338
|
-
# },
|
2339
|
-
# },
|
2340
|
-
# ],
|
2341
|
-
# processing_config: {
|
2342
|
-
# compute_location: "EDGE", # required, accepts EDGE, CLOUD
|
2343
|
-
# forwarding_config: {
|
2344
|
-
# state: "DISABLED", # required, accepts DISABLED, ENABLED
|
2345
|
-
# },
|
2346
|
-
# },
|
2347
|
-
# },
|
2348
|
-
# metric: {
|
2349
|
-
# expression: "Expression", # required
|
2350
|
-
# variables: [ # required
|
2351
|
-
# {
|
2352
|
-
# name: "VariableName", # required
|
2353
|
-
# value: { # required
|
2354
|
-
# property_id: "Macro", # required
|
2355
|
-
# hierarchy_id: "Macro",
|
2356
|
-
# },
|
2357
|
-
# },
|
2358
|
-
# ],
|
2359
|
-
# window: { # required
|
2360
|
-
# tumbling: {
|
2361
|
-
# interval: "Interval", # required
|
2362
|
-
# offset: "Offset",
|
2363
|
-
# },
|
2364
|
-
# },
|
2365
|
-
# processing_config: {
|
2366
|
-
# compute_location: "EDGE", # required, accepts EDGE, CLOUD
|
2367
|
-
# },
|
2368
|
-
# },
|
2369
|
-
# },
|
2370
|
-
# },
|
2371
|
-
# ],
|
2372
|
-
# asset_model_hierarchies: [
|
2373
|
-
# {
|
2374
|
-
# name: "Name", # required
|
2375
|
-
# child_asset_model_id: "ID", # required
|
2376
|
-
# },
|
2377
|
-
# ],
|
2378
|
-
# asset_model_composite_models: [
|
2379
|
-
# {
|
2380
|
-
# name: "Name", # required
|
2381
|
-
# description: "Description",
|
2382
|
-
# type: "Name", # required
|
2383
|
-
# properties: [
|
2384
|
-
# {
|
2385
|
-
# name: "Name", # required
|
2386
|
-
# data_type: "STRING", # required, accepts STRING, INTEGER, DOUBLE, BOOLEAN, STRUCT
|
2387
|
-
# data_type_spec: "Name",
|
2388
|
-
# unit: "PropertyUnit",
|
2389
|
-
# type: { # required
|
2390
|
-
# attribute: {
|
2391
|
-
# default_value: "DefaultValue",
|
2392
|
-
# },
|
2393
|
-
# measurement: {
|
2394
|
-
# processing_config: {
|
2395
|
-
# forwarding_config: { # required
|
2396
|
-
# state: "DISABLED", # required, accepts DISABLED, ENABLED
|
2397
|
-
# },
|
2398
|
-
# },
|
2399
|
-
# },
|
2400
|
-
# transform: {
|
2401
|
-
# expression: "Expression", # required
|
2402
|
-
# variables: [ # required
|
2403
|
-
# {
|
2404
|
-
# name: "VariableName", # required
|
2405
|
-
# value: { # required
|
2406
|
-
# property_id: "Macro", # required
|
2407
|
-
# hierarchy_id: "Macro",
|
2408
|
-
# },
|
2409
|
-
# },
|
2410
|
-
# ],
|
2411
|
-
# processing_config: {
|
2412
|
-
# compute_location: "EDGE", # required, accepts EDGE, CLOUD
|
2413
|
-
# forwarding_config: {
|
2414
|
-
# state: "DISABLED", # required, accepts DISABLED, ENABLED
|
2415
|
-
# },
|
2416
|
-
# },
|
2417
|
-
# },
|
2418
|
-
# metric: {
|
2419
|
-
# expression: "Expression", # required
|
2420
|
-
# variables: [ # required
|
2421
|
-
# {
|
2422
|
-
# name: "VariableName", # required
|
2423
|
-
# value: { # required
|
2424
|
-
# property_id: "Macro", # required
|
2425
|
-
# hierarchy_id: "Macro",
|
2426
|
-
# },
|
2427
|
-
# },
|
2428
|
-
# ],
|
2429
|
-
# window: { # required
|
2430
|
-
# tumbling: {
|
2431
|
-
# interval: "Interval", # required
|
2432
|
-
# offset: "Offset",
|
2433
|
-
# },
|
2434
|
-
# },
|
2435
|
-
# processing_config: {
|
2436
|
-
# compute_location: "EDGE", # required, accepts EDGE, CLOUD
|
2437
|
-
# },
|
2438
|
-
# },
|
2439
|
-
# },
|
2440
|
-
# },
|
2441
|
-
# ],
|
2442
|
-
# },
|
2443
|
-
# ],
|
2444
|
-
# client_token: "ClientToken",
|
2445
|
-
# tags: {
|
2446
|
-
# "TagKey" => "TagValue",
|
2447
|
-
# },
|
2448
|
-
# }
|
2449
|
-
#
|
2450
1909
|
# @!attribute [rw] asset_model_name
|
2451
1910
|
# A unique, friendly name for the asset model.
|
2452
1911
|
# @return [String]
|
@@ -2550,19 +2009,6 @@ module Aws::IoTSiteWise
|
|
2550
2009
|
include Aws::Structure
|
2551
2010
|
end
|
2552
2011
|
|
2553
|
-
# @note When making an API call, you may pass CreateAssetRequest
|
2554
|
-
# data as a hash:
|
2555
|
-
#
|
2556
|
-
# {
|
2557
|
-
# asset_name: "Name", # required
|
2558
|
-
# asset_model_id: "ID", # required
|
2559
|
-
# client_token: "ClientToken",
|
2560
|
-
# tags: {
|
2561
|
-
# "TagKey" => "TagValue",
|
2562
|
-
# },
|
2563
|
-
# asset_description: "Description",
|
2564
|
-
# }
|
2565
|
-
#
|
2566
2012
|
# @!attribute [rw] asset_name
|
2567
2013
|
# A friendly name for the asset.
|
2568
2014
|
# @return [String]
|
@@ -2632,32 +2078,6 @@ module Aws::IoTSiteWise
|
|
2632
2078
|
include Aws::Structure
|
2633
2079
|
end
|
2634
2080
|
|
2635
|
-
# @note When making an API call, you may pass CreateBulkImportJobRequest
|
2636
|
-
# data as a hash:
|
2637
|
-
#
|
2638
|
-
# {
|
2639
|
-
# job_name: "Name", # required
|
2640
|
-
# job_role_arn: "ARN", # required
|
2641
|
-
# files: [ # required
|
2642
|
-
# {
|
2643
|
-
# bucket: "Bucket", # required
|
2644
|
-
# key: "String", # required
|
2645
|
-
# version_id: "String",
|
2646
|
-
# },
|
2647
|
-
# ],
|
2648
|
-
# error_report_location: { # required
|
2649
|
-
# bucket: "Bucket", # required
|
2650
|
-
# prefix: "String", # required
|
2651
|
-
# },
|
2652
|
-
# job_configuration: { # required
|
2653
|
-
# file_format: { # required
|
2654
|
-
# csv: {
|
2655
|
-
# column_names: ["ALIAS"], # accepts ALIAS, ASSET_ID, PROPERTY_ID, DATA_TYPE, TIMESTAMP_SECONDS, TIMESTAMP_NANO_OFFSET, QUALITY, VALUE
|
2656
|
-
# },
|
2657
|
-
# },
|
2658
|
-
# },
|
2659
|
-
# }
|
2660
|
-
#
|
2661
2081
|
# @!attribute [rw] job_name
|
2662
2082
|
# The unique name that helps identify the job request.
|
2663
2083
|
# @return [String]
|
@@ -2735,20 +2155,6 @@ module Aws::IoTSiteWise
|
|
2735
2155
|
include Aws::Structure
|
2736
2156
|
end
|
2737
2157
|
|
2738
|
-
# @note When making an API call, you may pass CreateDashboardRequest
|
2739
|
-
# data as a hash:
|
2740
|
-
#
|
2741
|
-
# {
|
2742
|
-
# project_id: "ID", # required
|
2743
|
-
# dashboard_name: "Name", # required
|
2744
|
-
# dashboard_description: "Description",
|
2745
|
-
# dashboard_definition: "DashboardDefinition", # required
|
2746
|
-
# client_token: "ClientToken",
|
2747
|
-
# tags: {
|
2748
|
-
# "TagKey" => "TagValue",
|
2749
|
-
# },
|
2750
|
-
# }
|
2751
|
-
#
|
2752
2158
|
# @!attribute [rw] project_id
|
2753
2159
|
# The ID of the project in which to create the dashboard.
|
2754
2160
|
# @return [String]
|
@@ -2822,24 +2228,6 @@ module Aws::IoTSiteWise
|
|
2822
2228
|
include Aws::Structure
|
2823
2229
|
end
|
2824
2230
|
|
2825
|
-
# @note When making an API call, you may pass CreateGatewayRequest
|
2826
|
-
# data as a hash:
|
2827
|
-
#
|
2828
|
-
# {
|
2829
|
-
# gateway_name: "Name", # required
|
2830
|
-
# gateway_platform: { # required
|
2831
|
-
# greengrass: {
|
2832
|
-
# group_arn: "ARN", # required
|
2833
|
-
# },
|
2834
|
-
# greengrass_v2: {
|
2835
|
-
# core_device_thing_name: "CoreDeviceThingName", # required
|
2836
|
-
# },
|
2837
|
-
# },
|
2838
|
-
# tags: {
|
2839
|
-
# "TagKey" => "TagValue",
|
2840
|
-
# },
|
2841
|
-
# }
|
2842
|
-
#
|
2843
2231
|
# @!attribute [rw] gateway_name
|
2844
2232
|
# A unique, friendly name for the gateway.
|
2845
2233
|
# @return [String]
|
@@ -2889,30 +2277,6 @@ module Aws::IoTSiteWise
|
|
2889
2277
|
include Aws::Structure
|
2890
2278
|
end
|
2891
2279
|
|
2892
|
-
# @note When making an API call, you may pass CreatePortalRequest
|
2893
|
-
# data as a hash:
|
2894
|
-
#
|
2895
|
-
# {
|
2896
|
-
# portal_name: "Name", # required
|
2897
|
-
# portal_description: "Description",
|
2898
|
-
# portal_contact_email: "Email", # required
|
2899
|
-
# client_token: "ClientToken",
|
2900
|
-
# portal_logo_image_file: {
|
2901
|
-
# data: "data", # required
|
2902
|
-
# type: "PNG", # required, accepts PNG
|
2903
|
-
# },
|
2904
|
-
# role_arn: "ARN", # required
|
2905
|
-
# tags: {
|
2906
|
-
# "TagKey" => "TagValue",
|
2907
|
-
# },
|
2908
|
-
# portal_auth_mode: "IAM", # accepts IAM, SSO
|
2909
|
-
# notification_sender_email: "Email",
|
2910
|
-
# alarms: {
|
2911
|
-
# alarm_role_arn: "ARN", # required
|
2912
|
-
# notification_lambda_arn: "ARN",
|
2913
|
-
# },
|
2914
|
-
# }
|
2915
|
-
#
|
2916
2280
|
# @!attribute [rw] portal_name
|
2917
2281
|
# A friendly name for the portal.
|
2918
2282
|
# @return [String]
|
@@ -2965,11 +2329,11 @@ module Aws::IoTSiteWise
|
|
2965
2329
|
# The service to use to authenticate users to the portal. Choose from
|
2966
2330
|
# the following options:
|
2967
2331
|
#
|
2968
|
-
# * `SSO` – The portal uses
|
2969
|
-
# authenticate users and manage user permissions. Before
|
2970
|
-
# create a portal that uses
|
2971
|
-
#
|
2972
|
-
#
|
2332
|
+
# * `SSO` – The portal uses IAM Identity Center (successor to Single
|
2333
|
+
# Sign-On) to authenticate users and manage user permissions. Before
|
2334
|
+
# you can create a portal that uses IAM Identity Center, you must
|
2335
|
+
# enable IAM Identity Center. For more information, see [Enabling
|
2336
|
+
# IAM Identity Center][1] in the *IoT SiteWise User Guide*. This
|
2973
2337
|
# option is only available in Amazon Web Services Regions other than
|
2974
2338
|
# the China Regions.
|
2975
2339
|
#
|
@@ -3041,8 +2405,8 @@ module Aws::IoTSiteWise
|
|
3041
2405
|
#
|
3042
2406
|
# @!attribute [rw] portal_start_url
|
3043
2407
|
# The URL for the IoT SiteWise Monitor portal. You can use this URL to
|
3044
|
-
# access portals that use
|
3045
|
-
#
|
2408
|
+
# access portals that use IAM Identity Center for authentication. For
|
2409
|
+
# portals that use IAM for authentication, you must use the IoT
|
3046
2410
|
# SiteWise console to get a URL that you can use to access the portal.
|
3047
2411
|
# @return [String]
|
3048
2412
|
#
|
@@ -3052,8 +2416,8 @@ module Aws::IoTSiteWise
|
|
3052
2416
|
# @return [Types::PortalStatus]
|
3053
2417
|
#
|
3054
2418
|
# @!attribute [rw] sso_application_id
|
3055
|
-
# The associated
|
3056
|
-
# uses
|
2419
|
+
# The associated IAM Identity Center application ID, if the portal
|
2420
|
+
# uses IAM Identity Center.
|
3057
2421
|
# @return [String]
|
3058
2422
|
#
|
3059
2423
|
class CreatePortalResponse < Struct.new(
|
@@ -3066,19 +2430,6 @@ module Aws::IoTSiteWise
|
|
3066
2430
|
include Aws::Structure
|
3067
2431
|
end
|
3068
2432
|
|
3069
|
-
# @note When making an API call, you may pass CreateProjectRequest
|
3070
|
-
# data as a hash:
|
3071
|
-
#
|
3072
|
-
# {
|
3073
|
-
# portal_id: "ID", # required
|
3074
|
-
# project_name: "Name", # required
|
3075
|
-
# project_description: "Description",
|
3076
|
-
# client_token: "ClientToken",
|
3077
|
-
# tags: {
|
3078
|
-
# "TagKey" => "TagValue",
|
3079
|
-
# },
|
3080
|
-
# }
|
3081
|
-
#
|
3082
2433
|
# @!attribute [rw] portal_id
|
3083
2434
|
# The ID of the portal in which to create the project.
|
3084
2435
|
# @return [String]
|
@@ -3143,13 +2494,6 @@ module Aws::IoTSiteWise
|
|
3143
2494
|
|
3144
2495
|
# A .csv file.
|
3145
2496
|
#
|
3146
|
-
# @note When making an API call, you may pass Csv
|
3147
|
-
# data as a hash:
|
3148
|
-
#
|
3149
|
-
# {
|
3150
|
-
# column_names: ["ALIAS"], # accepts ALIAS, ASSET_ID, PROPERTY_ID, DATA_TYPE, TIMESTAMP_SECONDS, TIMESTAMP_NANO_OFFSET, QUALITY, VALUE
|
3151
|
-
# }
|
3152
|
-
#
|
3153
2497
|
# @!attribute [rw] column_names
|
3154
2498
|
# The column names specified in the .csv file.
|
3155
2499
|
# @return [Array<String>]
|
@@ -3162,14 +2506,6 @@ module Aws::IoTSiteWise
|
|
3162
2506
|
|
3163
2507
|
# Contains information about a customer managed Amazon S3 bucket.
|
3164
2508
|
#
|
3165
|
-
# @note When making an API call, you may pass CustomerManagedS3Storage
|
3166
|
-
# data as a hash:
|
3167
|
-
#
|
3168
|
-
# {
|
3169
|
-
# s3_resource_arn: "ARN", # required
|
3170
|
-
# role_arn: "ARN", # required
|
3171
|
-
# }
|
3172
|
-
#
|
3173
2509
|
# @!attribute [rw] s3_resource_arn
|
3174
2510
|
# The [ARN][1] of the Amazon S3 object. For more information about how
|
3175
2511
|
# to find the ARN for an Amazon S3 object, see [Amazon S3
|
@@ -3229,14 +2565,6 @@ module Aws::IoTSiteWise
|
|
3229
2565
|
include Aws::Structure
|
3230
2566
|
end
|
3231
2567
|
|
3232
|
-
# @note When making an API call, you may pass DeleteAccessPolicyRequest
|
3233
|
-
# data as a hash:
|
3234
|
-
#
|
3235
|
-
# {
|
3236
|
-
# access_policy_id: "ID", # required
|
3237
|
-
# client_token: "ClientToken",
|
3238
|
-
# }
|
3239
|
-
#
|
3240
2568
|
# @!attribute [rw] access_policy_id
|
3241
2569
|
# The ID of the access policy to be deleted.
|
3242
2570
|
# @return [String]
|
@@ -3259,14 +2587,6 @@ module Aws::IoTSiteWise
|
|
3259
2587
|
|
3260
2588
|
class DeleteAccessPolicyResponse < Aws::EmptyStructure; end
|
3261
2589
|
|
3262
|
-
# @note When making an API call, you may pass DeleteAssetModelRequest
|
3263
|
-
# data as a hash:
|
3264
|
-
#
|
3265
|
-
# {
|
3266
|
-
# asset_model_id: "ID", # required
|
3267
|
-
# client_token: "ClientToken",
|
3268
|
-
# }
|
3269
|
-
#
|
3270
2590
|
# @!attribute [rw] asset_model_id
|
3271
2591
|
# The ID of the asset model to delete.
|
3272
2592
|
# @return [String]
|
@@ -3298,14 +2618,6 @@ module Aws::IoTSiteWise
|
|
3298
2618
|
include Aws::Structure
|
3299
2619
|
end
|
3300
2620
|
|
3301
|
-
# @note When making an API call, you may pass DeleteAssetRequest
|
3302
|
-
# data as a hash:
|
3303
|
-
#
|
3304
|
-
# {
|
3305
|
-
# asset_id: "ID", # required
|
3306
|
-
# client_token: "ClientToken",
|
3307
|
-
# }
|
3308
|
-
#
|
3309
2621
|
# @!attribute [rw] asset_id
|
3310
2622
|
# The ID of the asset to delete.
|
3311
2623
|
# @return [String]
|
@@ -3337,14 +2649,6 @@ module Aws::IoTSiteWise
|
|
3337
2649
|
include Aws::Structure
|
3338
2650
|
end
|
3339
2651
|
|
3340
|
-
# @note When making an API call, you may pass DeleteDashboardRequest
|
3341
|
-
# data as a hash:
|
3342
|
-
#
|
3343
|
-
# {
|
3344
|
-
# dashboard_id: "ID", # required
|
3345
|
-
# client_token: "ClientToken",
|
3346
|
-
# }
|
3347
|
-
#
|
3348
2652
|
# @!attribute [rw] dashboard_id
|
3349
2653
|
# The ID of the dashboard to delete.
|
3350
2654
|
# @return [String]
|
@@ -3367,13 +2671,6 @@ module Aws::IoTSiteWise
|
|
3367
2671
|
|
3368
2672
|
class DeleteDashboardResponse < Aws::EmptyStructure; end
|
3369
2673
|
|
3370
|
-
# @note When making an API call, you may pass DeleteGatewayRequest
|
3371
|
-
# data as a hash:
|
3372
|
-
#
|
3373
|
-
# {
|
3374
|
-
# gateway_id: "ID", # required
|
3375
|
-
# }
|
3376
|
-
#
|
3377
2674
|
# @!attribute [rw] gateway_id
|
3378
2675
|
# The ID of the gateway to delete.
|
3379
2676
|
# @return [String]
|
@@ -3384,14 +2681,6 @@ module Aws::IoTSiteWise
|
|
3384
2681
|
include Aws::Structure
|
3385
2682
|
end
|
3386
2683
|
|
3387
|
-
# @note When making an API call, you may pass DeletePortalRequest
|
3388
|
-
# data as a hash:
|
3389
|
-
#
|
3390
|
-
# {
|
3391
|
-
# portal_id: "ID", # required
|
3392
|
-
# client_token: "ClientToken",
|
3393
|
-
# }
|
3394
|
-
#
|
3395
2684
|
# @!attribute [rw] portal_id
|
3396
2685
|
# The ID of the portal to delete.
|
3397
2686
|
# @return [String]
|
@@ -3423,14 +2712,6 @@ module Aws::IoTSiteWise
|
|
3423
2712
|
include Aws::Structure
|
3424
2713
|
end
|
3425
2714
|
|
3426
|
-
# @note When making an API call, you may pass DeleteProjectRequest
|
3427
|
-
# data as a hash:
|
3428
|
-
#
|
3429
|
-
# {
|
3430
|
-
# project_id: "ID", # required
|
3431
|
-
# client_token: "ClientToken",
|
3432
|
-
# }
|
3433
|
-
#
|
3434
2715
|
# @!attribute [rw] project_id
|
3435
2716
|
# The ID of the project.
|
3436
2717
|
# @return [String]
|
@@ -3453,16 +2734,6 @@ module Aws::IoTSiteWise
|
|
3453
2734
|
|
3454
2735
|
class DeleteProjectResponse < Aws::EmptyStructure; end
|
3455
2736
|
|
3456
|
-
# @note When making an API call, you may pass DeleteTimeSeriesRequest
|
3457
|
-
# data as a hash:
|
3458
|
-
#
|
3459
|
-
# {
|
3460
|
-
# alias: "PropertyAlias",
|
3461
|
-
# asset_id: "ID",
|
3462
|
-
# property_id: "ID",
|
3463
|
-
# client_token: "ClientToken",
|
3464
|
-
# }
|
3465
|
-
#
|
3466
2737
|
# @!attribute [rw] alias
|
3467
2738
|
# The alias that identifies the time series.
|
3468
2739
|
# @return [String]
|
@@ -3493,13 +2764,6 @@ module Aws::IoTSiteWise
|
|
3493
2764
|
include Aws::Structure
|
3494
2765
|
end
|
3495
2766
|
|
3496
|
-
# @note When making an API call, you may pass DescribeAccessPolicyRequest
|
3497
|
-
# data as a hash:
|
3498
|
-
#
|
3499
|
-
# {
|
3500
|
-
# access_policy_id: "ID", # required
|
3501
|
-
# }
|
3502
|
-
#
|
3503
2767
|
# @!attribute [rw] access_policy_id
|
3504
2768
|
# The ID of the access policy.
|
3505
2769
|
# @return [String]
|
@@ -3525,8 +2789,8 @@ module Aws::IoTSiteWise
|
|
3525
2789
|
# @return [String]
|
3526
2790
|
#
|
3527
2791
|
# @!attribute [rw] access_policy_identity
|
3528
|
-
# The identity (
|
3529
|
-
#
|
2792
|
+
# The identity (IAM Identity Center user, IAM Identity Center group,
|
2793
|
+
# or IAM user) to which this access policy applies.
|
3530
2794
|
# @return [Types::Identity]
|
3531
2795
|
#
|
3532
2796
|
# @!attribute [rw] access_policy_resource
|
@@ -3559,19 +2823,17 @@ module Aws::IoTSiteWise
|
|
3559
2823
|
include Aws::Structure
|
3560
2824
|
end
|
3561
2825
|
|
3562
|
-
# @note When making an API call, you may pass DescribeAssetModelRequest
|
3563
|
-
# data as a hash:
|
3564
|
-
#
|
3565
|
-
# {
|
3566
|
-
# asset_model_id: "ID", # required
|
3567
|
-
# }
|
3568
|
-
#
|
3569
2826
|
# @!attribute [rw] asset_model_id
|
3570
2827
|
# The ID of the asset model.
|
3571
2828
|
# @return [String]
|
3572
2829
|
#
|
2830
|
+
# @!attribute [rw] exclude_properties
|
2831
|
+
# Whether or not to exclude asset model properties from the response.
|
2832
|
+
# @return [Boolean]
|
2833
|
+
#
|
3573
2834
|
class DescribeAssetModelRequest < Struct.new(
|
3574
|
-
:asset_model_id
|
2835
|
+
:asset_model_id,
|
2836
|
+
:exclude_properties)
|
3575
2837
|
SENSITIVE = []
|
3576
2838
|
include Aws::Structure
|
3577
2839
|
end
|
@@ -3645,14 +2907,6 @@ module Aws::IoTSiteWise
|
|
3645
2907
|
include Aws::Structure
|
3646
2908
|
end
|
3647
2909
|
|
3648
|
-
# @note When making an API call, you may pass DescribeAssetPropertyRequest
|
3649
|
-
# data as a hash:
|
3650
|
-
#
|
3651
|
-
# {
|
3652
|
-
# asset_id: "ID", # required
|
3653
|
-
# property_id: "ID", # required
|
3654
|
-
# }
|
3655
|
-
#
|
3656
2910
|
# @!attribute [rw] asset_id
|
3657
2911
|
# The ID of the asset.
|
3658
2912
|
# @return [String]
|
@@ -3703,19 +2957,17 @@ module Aws::IoTSiteWise
|
|
3703
2957
|
include Aws::Structure
|
3704
2958
|
end
|
3705
2959
|
|
3706
|
-
# @note When making an API call, you may pass DescribeAssetRequest
|
3707
|
-
# data as a hash:
|
3708
|
-
#
|
3709
|
-
# {
|
3710
|
-
# asset_id: "ID", # required
|
3711
|
-
# }
|
3712
|
-
#
|
3713
2960
|
# @!attribute [rw] asset_id
|
3714
2961
|
# The ID of the asset.
|
3715
2962
|
# @return [String]
|
3716
2963
|
#
|
2964
|
+
# @!attribute [rw] exclude_properties
|
2965
|
+
# Whether or not to exclude asset properties from the response.
|
2966
|
+
# @return [Boolean]
|
2967
|
+
#
|
3717
2968
|
class DescribeAssetRequest < Struct.new(
|
3718
|
-
:asset_id
|
2969
|
+
:asset_id,
|
2970
|
+
:exclude_properties)
|
3719
2971
|
SENSITIVE = []
|
3720
2972
|
include Aws::Structure
|
3721
2973
|
end
|
@@ -3792,13 +3044,6 @@ module Aws::IoTSiteWise
|
|
3792
3044
|
include Aws::Structure
|
3793
3045
|
end
|
3794
3046
|
|
3795
|
-
# @note When making an API call, you may pass DescribeBulkImportJobRequest
|
3796
|
-
# data as a hash:
|
3797
|
-
#
|
3798
|
-
# {
|
3799
|
-
# job_id: "ID", # required
|
3800
|
-
# }
|
3801
|
-
#
|
3802
3047
|
# @!attribute [rw] job_id
|
3803
3048
|
# The ID of the job.
|
3804
3049
|
# @return [String]
|
@@ -3886,13 +3131,6 @@ module Aws::IoTSiteWise
|
|
3886
3131
|
include Aws::Structure
|
3887
3132
|
end
|
3888
3133
|
|
3889
|
-
# @note When making an API call, you may pass DescribeDashboardRequest
|
3890
|
-
# data as a hash:
|
3891
|
-
#
|
3892
|
-
# {
|
3893
|
-
# dashboard_id: "ID", # required
|
3894
|
-
# }
|
3895
|
-
#
|
3896
3134
|
# @!attribute [rw] dashboard_id
|
3897
3135
|
# The ID of the dashboard.
|
3898
3136
|
# @return [String]
|
@@ -3986,14 +3224,6 @@ module Aws::IoTSiteWise
|
|
3986
3224
|
include Aws::Structure
|
3987
3225
|
end
|
3988
3226
|
|
3989
|
-
# @note When making an API call, you may pass DescribeGatewayCapabilityConfigurationRequest
|
3990
|
-
# data as a hash:
|
3991
|
-
#
|
3992
|
-
# {
|
3993
|
-
# gateway_id: "ID", # required
|
3994
|
-
# capability_namespace: "CapabilityNamespace", # required
|
3995
|
-
# }
|
3996
|
-
#
|
3997
3227
|
# @!attribute [rw] gateway_id
|
3998
3228
|
# The ID of the gateway that defines the capability configuration.
|
3999
3229
|
# @return [String]
|
@@ -4052,13 +3282,6 @@ module Aws::IoTSiteWise
|
|
4052
3282
|
include Aws::Structure
|
4053
3283
|
end
|
4054
3284
|
|
4055
|
-
# @note When making an API call, you may pass DescribeGatewayRequest
|
4056
|
-
# data as a hash:
|
4057
|
-
#
|
4058
|
-
# {
|
4059
|
-
# gateway_id: "ID", # required
|
4060
|
-
# }
|
4061
|
-
#
|
4062
3285
|
# @!attribute [rw] gateway_id
|
4063
3286
|
# The ID of the gateway device.
|
4064
3287
|
# @return [String]
|
@@ -4136,13 +3359,6 @@ module Aws::IoTSiteWise
|
|
4136
3359
|
include Aws::Structure
|
4137
3360
|
end
|
4138
3361
|
|
4139
|
-
# @note When making an API call, you may pass DescribePortalRequest
|
4140
|
-
# data as a hash:
|
4141
|
-
#
|
4142
|
-
# {
|
4143
|
-
# portal_id: "ID", # required
|
4144
|
-
# }
|
4145
|
-
#
|
4146
3362
|
# @!attribute [rw] portal_id
|
4147
3363
|
# The ID of the portal.
|
4148
3364
|
# @return [String]
|
@@ -4176,16 +3392,15 @@ module Aws::IoTSiteWise
|
|
4176
3392
|
# @return [String]
|
4177
3393
|
#
|
4178
3394
|
# @!attribute [rw] portal_client_id
|
4179
|
-
# The
|
4180
|
-
#
|
4181
|
-
#
|
4182
|
-
# to authenticate users.
|
3395
|
+
# The IAM Identity Center application generated client ID (used with
|
3396
|
+
# IAM Identity Center APIs). IoT SiteWise includes `portalClientId`
|
3397
|
+
# for only portals that use IAM Identity Center to authenticate users.
|
4183
3398
|
# @return [String]
|
4184
3399
|
#
|
4185
3400
|
# @!attribute [rw] portal_start_url
|
4186
3401
|
# The URL for the IoT SiteWise Monitor portal. You can use this URL to
|
4187
|
-
# access portals that use
|
4188
|
-
#
|
3402
|
+
# access portals that use IAM Identity Center for authentication. For
|
3403
|
+
# portals that use IAM for authentication, you must use the IoT
|
4189
3404
|
# SiteWise console to get a URL that you can use to access the portal.
|
4190
3405
|
# @return [String]
|
4191
3406
|
#
|
@@ -4255,13 +3470,6 @@ module Aws::IoTSiteWise
|
|
4255
3470
|
include Aws::Structure
|
4256
3471
|
end
|
4257
3472
|
|
4258
|
-
# @note When making an API call, you may pass DescribeProjectRequest
|
4259
|
-
# data as a hash:
|
4260
|
-
#
|
4261
|
-
# {
|
4262
|
-
# project_id: "ID", # required
|
4263
|
-
# }
|
4264
|
-
#
|
4265
3473
|
# @!attribute [rw] project_id
|
4266
3474
|
# The ID of the project.
|
4267
3475
|
# @return [String]
|
@@ -4385,15 +3593,6 @@ module Aws::IoTSiteWise
|
|
4385
3593
|
include Aws::Structure
|
4386
3594
|
end
|
4387
3595
|
|
4388
|
-
# @note When making an API call, you may pass DescribeTimeSeriesRequest
|
4389
|
-
# data as a hash:
|
4390
|
-
#
|
4391
|
-
# {
|
4392
|
-
# alias: "PropertyAlias",
|
4393
|
-
# asset_id: "ID",
|
4394
|
-
# property_id: "ID",
|
4395
|
-
# }
|
4396
|
-
#
|
4397
3596
|
# @!attribute [rw] alias
|
4398
3597
|
# The alias that identifies the time series.
|
4399
3598
|
# @return [String]
|
@@ -4485,16 +3684,6 @@ module Aws::IoTSiteWise
|
|
4485
3684
|
include Aws::Structure
|
4486
3685
|
end
|
4487
3686
|
|
4488
|
-
# @note When making an API call, you may pass DisassociateAssetsRequest
|
4489
|
-
# data as a hash:
|
4490
|
-
#
|
4491
|
-
# {
|
4492
|
-
# asset_id: "ID", # required
|
4493
|
-
# hierarchy_id: "ID", # required
|
4494
|
-
# child_asset_id: "ID", # required
|
4495
|
-
# client_token: "ClientToken",
|
4496
|
-
# }
|
4497
|
-
#
|
4498
3687
|
# @!attribute [rw] asset_id
|
4499
3688
|
# The ID of the parent asset from which to disassociate the child
|
4500
3689
|
# asset.
|
@@ -4534,16 +3723,6 @@ module Aws::IoTSiteWise
|
|
4534
3723
|
include Aws::Structure
|
4535
3724
|
end
|
4536
3725
|
|
4537
|
-
# @note When making an API call, you may pass DisassociateTimeSeriesFromAssetPropertyRequest
|
4538
|
-
# data as a hash:
|
4539
|
-
#
|
4540
|
-
# {
|
4541
|
-
# alias: "PropertyAlias", # required
|
4542
|
-
# asset_id: "ID", # required
|
4543
|
-
# property_id: "ID", # required
|
4544
|
-
# client_token: "ClientToken",
|
4545
|
-
# }
|
4546
|
-
#
|
4547
3726
|
# @!attribute [rw] alias
|
4548
3727
|
# The alias that identifies the time series.
|
4549
3728
|
# @return [String]
|
@@ -4599,14 +3778,6 @@ module Aws::IoTSiteWise
|
|
4599
3778
|
# The Amazon S3 destination where errors associated with the job
|
4600
3779
|
# creation request are saved.
|
4601
3780
|
#
|
4602
|
-
# @note When making an API call, you may pass ErrorReportLocation
|
4603
|
-
# data as a hash:
|
4604
|
-
#
|
4605
|
-
# {
|
4606
|
-
# bucket: "Bucket", # required
|
4607
|
-
# prefix: "String", # required
|
4608
|
-
# }
|
4609
|
-
#
|
4610
3781
|
# @!attribute [rw] bucket
|
4611
3782
|
# The name of the Amazon S3 bucket to which errors associated with the
|
4612
3783
|
# bulk import job are sent.
|
@@ -4634,17 +3805,6 @@ module Aws::IoTSiteWise
|
|
4634
3805
|
|
4635
3806
|
# Contains expression variable information.
|
4636
3807
|
#
|
4637
|
-
# @note When making an API call, you may pass ExpressionVariable
|
4638
|
-
# data as a hash:
|
4639
|
-
#
|
4640
|
-
# {
|
4641
|
-
# name: "VariableName", # required
|
4642
|
-
# value: { # required
|
4643
|
-
# property_id: "Macro", # required
|
4644
|
-
# hierarchy_id: "Macro",
|
4645
|
-
# },
|
4646
|
-
# }
|
4647
|
-
#
|
4648
3808
|
# @!attribute [rw] name
|
4649
3809
|
# The friendly name of the variable to be used in the expression.
|
4650
3810
|
# @return [String]
|
@@ -4663,15 +3823,6 @@ module Aws::IoTSiteWise
|
|
4663
3823
|
|
4664
3824
|
# The file in Amazon S3 where your data is saved.
|
4665
3825
|
#
|
4666
|
-
# @note When making an API call, you may pass File
|
4667
|
-
# data as a hash:
|
4668
|
-
#
|
4669
|
-
# {
|
4670
|
-
# bucket: "Bucket", # required
|
4671
|
-
# key: "String", # required
|
4672
|
-
# version_id: "String",
|
4673
|
-
# }
|
4674
|
-
#
|
4675
3826
|
# @!attribute [rw] bucket
|
4676
3827
|
# The name of the Amazon S3 bucket from which data is imported.
|
4677
3828
|
# @return [String]
|
@@ -4697,15 +3848,6 @@ module Aws::IoTSiteWise
|
|
4697
3848
|
|
4698
3849
|
# The file format of the data.
|
4699
3850
|
#
|
4700
|
-
# @note When making an API call, you may pass FileFormat
|
4701
|
-
# data as a hash:
|
4702
|
-
#
|
4703
|
-
# {
|
4704
|
-
# csv: {
|
4705
|
-
# column_names: ["ALIAS"], # accepts ALIAS, ASSET_ID, PROPERTY_ID, DATA_TYPE, TIMESTAMP_SECONDS, TIMESTAMP_NANO_OFFSET, QUALITY, VALUE
|
4706
|
-
# },
|
4707
|
-
# }
|
4708
|
-
#
|
4709
3851
|
# @!attribute [rw] csv
|
4710
3852
|
# The .csv file format.
|
4711
3853
|
# @return [Types::Csv]
|
@@ -4718,13 +3860,6 @@ module Aws::IoTSiteWise
|
|
4718
3860
|
|
4719
3861
|
# The forwarding configuration for a given property.
|
4720
3862
|
#
|
4721
|
-
# @note When making an API call, you may pass ForwardingConfig
|
4722
|
-
# data as a hash:
|
4723
|
-
#
|
4724
|
-
# {
|
4725
|
-
# state: "DISABLED", # required, accepts DISABLED, ENABLED
|
4726
|
-
# }
|
4727
|
-
#
|
4728
3863
|
# @!attribute [rw] state
|
4729
3864
|
# The forwarding state for the given property.
|
4730
3865
|
# @return [String]
|
@@ -4766,18 +3901,6 @@ module Aws::IoTSiteWise
|
|
4766
3901
|
|
4767
3902
|
# Contains a gateway's platform information.
|
4768
3903
|
#
|
4769
|
-
# @note When making an API call, you may pass GatewayPlatform
|
4770
|
-
# data as a hash:
|
4771
|
-
#
|
4772
|
-
# {
|
4773
|
-
# greengrass: {
|
4774
|
-
# group_arn: "ARN", # required
|
4775
|
-
# },
|
4776
|
-
# greengrass_v2: {
|
4777
|
-
# core_device_thing_name: "CoreDeviceThingName", # required
|
4778
|
-
# },
|
4779
|
-
# }
|
4780
|
-
#
|
4781
3904
|
# @!attribute [rw] greengrass
|
4782
3905
|
# A gateway that runs on IoT Greengrass.
|
4783
3906
|
# @return [Types::Greengrass]
|
@@ -4837,23 +3960,6 @@ module Aws::IoTSiteWise
|
|
4837
3960
|
include Aws::Structure
|
4838
3961
|
end
|
4839
3962
|
|
4840
|
-
# @note When making an API call, you may pass GetAssetPropertyAggregatesRequest
|
4841
|
-
# data as a hash:
|
4842
|
-
#
|
4843
|
-
# {
|
4844
|
-
# asset_id: "ID",
|
4845
|
-
# property_id: "ID",
|
4846
|
-
# property_alias: "AssetPropertyAlias",
|
4847
|
-
# aggregate_types: ["AVERAGE"], # required, accepts AVERAGE, COUNT, MAXIMUM, MINIMUM, SUM, STANDARD_DEVIATION
|
4848
|
-
# resolution: "Resolution", # required
|
4849
|
-
# qualities: ["GOOD"], # accepts GOOD, BAD, UNCERTAIN
|
4850
|
-
# start_date: Time.now, # required
|
4851
|
-
# end_date: Time.now, # required
|
4852
|
-
# time_ordering: "ASCENDING", # accepts ASCENDING, DESCENDING
|
4853
|
-
# next_token: "NextToken",
|
4854
|
-
# max_results: 1,
|
4855
|
-
# }
|
4856
|
-
#
|
4857
3963
|
# @!attribute [rw] asset_id
|
4858
3964
|
# The ID of the asset.
|
4859
3965
|
# @return [String]
|
@@ -4944,21 +4050,6 @@ module Aws::IoTSiteWise
|
|
4944
4050
|
include Aws::Structure
|
4945
4051
|
end
|
4946
4052
|
|
4947
|
-
# @note When making an API call, you may pass GetAssetPropertyValueHistoryRequest
|
4948
|
-
# data as a hash:
|
4949
|
-
#
|
4950
|
-
# {
|
4951
|
-
# asset_id: "ID",
|
4952
|
-
# property_id: "ID",
|
4953
|
-
# property_alias: "AssetPropertyAlias",
|
4954
|
-
# start_date: Time.now,
|
4955
|
-
# end_date: Time.now,
|
4956
|
-
# qualities: ["GOOD"], # accepts GOOD, BAD, UNCERTAIN
|
4957
|
-
# time_ordering: "ASCENDING", # accepts ASCENDING, DESCENDING
|
4958
|
-
# next_token: "NextToken",
|
4959
|
-
# max_results: 1,
|
4960
|
-
# }
|
4961
|
-
#
|
4962
4053
|
# @!attribute [rw] asset_id
|
4963
4054
|
# The ID of the asset.
|
4964
4055
|
# @return [String]
|
@@ -5039,15 +4130,6 @@ module Aws::IoTSiteWise
|
|
5039
4130
|
include Aws::Structure
|
5040
4131
|
end
|
5041
4132
|
|
5042
|
-
# @note When making an API call, you may pass GetAssetPropertyValueRequest
|
5043
|
-
# data as a hash:
|
5044
|
-
#
|
5045
|
-
# {
|
5046
|
-
# asset_id: "ID",
|
5047
|
-
# property_id: "ID",
|
5048
|
-
# property_alias: "AssetPropertyAlias",
|
5049
|
-
# }
|
5050
|
-
#
|
5051
4133
|
# @!attribute [rw] asset_id
|
5052
4134
|
# The ID of the asset.
|
5053
4135
|
# @return [String]
|
@@ -5086,25 +4168,6 @@ module Aws::IoTSiteWise
|
|
5086
4168
|
include Aws::Structure
|
5087
4169
|
end
|
5088
4170
|
|
5089
|
-
# @note When making an API call, you may pass GetInterpolatedAssetPropertyValuesRequest
|
5090
|
-
# data as a hash:
|
5091
|
-
#
|
5092
|
-
# {
|
5093
|
-
# asset_id: "ID",
|
5094
|
-
# property_id: "ID",
|
5095
|
-
# property_alias: "AssetPropertyAlias",
|
5096
|
-
# start_time_in_seconds: 1, # required
|
5097
|
-
# start_time_offset_in_nanos: 1,
|
5098
|
-
# end_time_in_seconds: 1, # required
|
5099
|
-
# end_time_offset_in_nanos: 1,
|
5100
|
-
# quality: "GOOD", # required, accepts GOOD, BAD, UNCERTAIN
|
5101
|
-
# interval_in_seconds: 1, # required
|
5102
|
-
# next_token: "NextToken",
|
5103
|
-
# max_results: 1,
|
5104
|
-
# type: "InterpolationType", # required
|
5105
|
-
# interval_window_in_seconds: 1,
|
5106
|
-
# }
|
5107
|
-
#
|
5108
4171
|
# @!attribute [rw] asset_id
|
5109
4172
|
# The ID of the asset.
|
5110
4173
|
# @return [String]
|
@@ -5270,13 +4333,6 @@ module Aws::IoTSiteWise
|
|
5270
4333
|
#
|
5271
4334
|
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/gateway-connector.html
|
5272
4335
|
#
|
5273
|
-
# @note When making an API call, you may pass Greengrass
|
5274
|
-
# data as a hash:
|
5275
|
-
#
|
5276
|
-
# {
|
5277
|
-
# group_arn: "ARN", # required
|
5278
|
-
# }
|
5279
|
-
#
|
5280
4336
|
# @!attribute [rw] group_arn
|
5281
4337
|
# The [ARN][1] of the Greengrass group. For more information about how
|
5282
4338
|
# to find a group's ARN, see [ListGroups][2] and [GetGroup][3] in the
|
@@ -5307,13 +4363,6 @@ module Aws::IoTSiteWise
|
|
5307
4363
|
# [1]: https://docs.aws.amazon.com/greengrass/v2/developerguide/device-service-role.html
|
5308
4364
|
# [2]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/sw-gateways.html
|
5309
4365
|
#
|
5310
|
-
# @note When making an API call, you may pass GreengrassV2
|
5311
|
-
# data as a hash:
|
5312
|
-
#
|
5313
|
-
# {
|
5314
|
-
# core_device_thing_name: "CoreDeviceThingName", # required
|
5315
|
-
# }
|
5316
|
-
#
|
5317
4366
|
# @!attribute [rw] core_device_thing_name
|
5318
4367
|
# The name of the IoT thing for your IoT Greengrass V2 core device.
|
5319
4368
|
# @return [String]
|
@@ -5326,15 +4375,8 @@ module Aws::IoTSiteWise
|
|
5326
4375
|
|
5327
4376
|
# Contains information for a group identity in an access policy.
|
5328
4377
|
#
|
5329
|
-
# @note When making an API call, you may pass GroupIdentity
|
5330
|
-
# data as a hash:
|
5331
|
-
#
|
5332
|
-
# {
|
5333
|
-
# id: "IdentityId", # required
|
5334
|
-
# }
|
5335
|
-
#
|
5336
4378
|
# @!attribute [rw] id
|
5337
|
-
# The
|
4379
|
+
# The IAM Identity Center ID of the group.
|
5338
4380
|
# @return [String]
|
5339
4381
|
#
|
5340
4382
|
class GroupIdentity < Struct.new(
|
@@ -5350,13 +4392,6 @@ module Aws::IoTSiteWise
|
|
5350
4392
|
#
|
5351
4393
|
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html
|
5352
4394
|
#
|
5353
|
-
# @note When making an API call, you may pass IAMRoleIdentity
|
5354
|
-
# data as a hash:
|
5355
|
-
#
|
5356
|
-
# {
|
5357
|
-
# arn: "ARN", # required
|
5358
|
-
# }
|
5359
|
-
#
|
5360
4395
|
# @!attribute [rw] arn
|
5361
4396
|
# The ARN of the IAM role. For more information, see [IAM ARNs][1] in
|
5362
4397
|
# the *IAM User Guide*.
|
@@ -5374,13 +4409,6 @@ module Aws::IoTSiteWise
|
|
5374
4409
|
|
5375
4410
|
# Contains information about an Identity and Access Management user.
|
5376
4411
|
#
|
5377
|
-
# @note When making an API call, you may pass IAMUserIdentity
|
5378
|
-
# data as a hash:
|
5379
|
-
#
|
5380
|
-
# {
|
5381
|
-
# arn: "ARN", # required
|
5382
|
-
# }
|
5383
|
-
#
|
5384
4412
|
# @!attribute [rw] arn
|
5385
4413
|
# The ARN of the IAM user. For more information, see [IAM ARNs][1] in
|
5386
4414
|
# the *IAM User Guide*.
|
@@ -5404,10 +4432,10 @@ module Aws::IoTSiteWise
|
|
5404
4432
|
|
5405
4433
|
# Contains an identity that can access an IoT SiteWise Monitor resource.
|
5406
4434
|
#
|
5407
|
-
# <note markdown="1"> Currently, you can't use Amazon Web Services APIs to retrieve
|
5408
|
-
#
|
5409
|
-
#
|
5410
|
-
#
|
4435
|
+
# <note markdown="1"> Currently, you can't use Amazon Web Services APIs to retrieve IAM
|
4436
|
+
# Identity Center identity IDs. You can find the IAM Identity Center
|
4437
|
+
# identity IDs in the URL of user and group pages in the [IAM Identity
|
4438
|
+
# Center console][1].
|
5411
4439
|
#
|
5412
4440
|
# </note>
|
5413
4441
|
#
|
@@ -5415,30 +4443,12 @@ module Aws::IoTSiteWise
|
|
5415
4443
|
#
|
5416
4444
|
# [1]: https://console.aws.amazon.com/singlesignon
|
5417
4445
|
#
|
5418
|
-
# @note When making an API call, you may pass Identity
|
5419
|
-
# data as a hash:
|
5420
|
-
#
|
5421
|
-
# {
|
5422
|
-
# user: {
|
5423
|
-
# id: "IdentityId", # required
|
5424
|
-
# },
|
5425
|
-
# group: {
|
5426
|
-
# id: "IdentityId", # required
|
5427
|
-
# },
|
5428
|
-
# iam_user: {
|
5429
|
-
# arn: "ARN", # required
|
5430
|
-
# },
|
5431
|
-
# iam_role: {
|
5432
|
-
# arn: "ARN", # required
|
5433
|
-
# },
|
5434
|
-
# }
|
5435
|
-
#
|
5436
4446
|
# @!attribute [rw] user
|
5437
|
-
# An
|
4447
|
+
# An IAM Identity Center user identity.
|
5438
4448
|
# @return [Types::UserIdentity]
|
5439
4449
|
#
|
5440
4450
|
# @!attribute [rw] group
|
5441
|
-
# An
|
4451
|
+
# An IAM Identity Center group identity.
|
5442
4452
|
# @return [Types::GroupIdentity]
|
5443
4453
|
#
|
5444
4454
|
# @!attribute [rw] iam_user
|
@@ -5465,17 +4475,6 @@ module Aws::IoTSiteWise
|
|
5465
4475
|
# * The ID of an existing image. Choose this option to keep an existing
|
5466
4476
|
# image.
|
5467
4477
|
#
|
5468
|
-
# @note When making an API call, you may pass Image
|
5469
|
-
# data as a hash:
|
5470
|
-
#
|
5471
|
-
# {
|
5472
|
-
# id: "ID",
|
5473
|
-
# file: {
|
5474
|
-
# data: "data", # required
|
5475
|
-
# type: "PNG", # required, accepts PNG
|
5476
|
-
# },
|
5477
|
-
# }
|
5478
|
-
#
|
5479
4478
|
# @!attribute [rw] id
|
5480
4479
|
# The ID of an existing image. Specify this parameter to keep an
|
5481
4480
|
# existing image.
|
@@ -5494,14 +4493,6 @@ module Aws::IoTSiteWise
|
|
5494
4493
|
|
5495
4494
|
# Contains an image file.
|
5496
4495
|
#
|
5497
|
-
# @note When making an API call, you may pass ImageFile
|
5498
|
-
# data as a hash:
|
5499
|
-
#
|
5500
|
-
# {
|
5501
|
-
# data: "data", # required
|
5502
|
-
# type: "PNG", # required, accepts PNG
|
5503
|
-
# }
|
5504
|
-
#
|
5505
4496
|
# @!attribute [rw] data
|
5506
4497
|
# The image file contents, represented as a base64-encoded string. The
|
5507
4498
|
# file size must be less than 1 MB.
|
@@ -5581,17 +4572,6 @@ module Aws::IoTSiteWise
|
|
5581
4572
|
# Contains the configuration information of a job, such as the file
|
5582
4573
|
# format used to save data in Amazon S3.
|
5583
4574
|
#
|
5584
|
-
# @note When making an API call, you may pass JobConfiguration
|
5585
|
-
# data as a hash:
|
5586
|
-
#
|
5587
|
-
# {
|
5588
|
-
# file_format: { # required
|
5589
|
-
# csv: {
|
5590
|
-
# column_names: ["ALIAS"], # accepts ALIAS, ASSET_ID, PROPERTY_ID, DATA_TYPE, TIMESTAMP_SECONDS, TIMESTAMP_NANO_OFFSET, QUALITY, VALUE
|
5591
|
-
# },
|
5592
|
-
# },
|
5593
|
-
# }
|
5594
|
-
#
|
5595
4575
|
# @!attribute [rw] file_format
|
5596
4576
|
# The file format of the data in Amazon S3.
|
5597
4577
|
# @return [Types::FileFormat]
|
@@ -5665,23 +4645,10 @@ module Aws::IoTSiteWise
|
|
5665
4645
|
include Aws::Structure
|
5666
4646
|
end
|
5667
4647
|
|
5668
|
-
# @note When making an API call, you may pass ListAccessPoliciesRequest
|
5669
|
-
# data as a hash:
|
5670
|
-
#
|
5671
|
-
# {
|
5672
|
-
# identity_type: "USER", # accepts USER, GROUP, IAM
|
5673
|
-
# identity_id: "IdentityId",
|
5674
|
-
# resource_type: "PORTAL", # accepts PORTAL, PROJECT
|
5675
|
-
# resource_id: "ID",
|
5676
|
-
# iam_arn: "ARN",
|
5677
|
-
# next_token: "NextToken",
|
5678
|
-
# max_results: 1,
|
5679
|
-
# }
|
5680
|
-
#
|
5681
4648
|
# @!attribute [rw] identity_type
|
5682
|
-
# The type of identity (
|
5683
|
-
#
|
5684
|
-
#
|
4649
|
+
# The type of identity (IAM Identity Center user, IAM Identity Center
|
4650
|
+
# group, or IAM user). This parameter is required if you specify
|
4651
|
+
# `identityId`.
|
5685
4652
|
# @return [String]
|
5686
4653
|
#
|
5687
4654
|
# @!attribute [rw] identity_id
|
@@ -5747,14 +4714,58 @@ module Aws::IoTSiteWise
|
|
5747
4714
|
include Aws::Structure
|
5748
4715
|
end
|
5749
4716
|
|
5750
|
-
#
|
5751
|
-
#
|
4717
|
+
# @!attribute [rw] asset_model_id
|
4718
|
+
# The ID of the asset model.
|
4719
|
+
# @return [String]
|
4720
|
+
#
|
4721
|
+
# @!attribute [rw] next_token
|
4722
|
+
# The token to be used for the next set of paginated results.
|
4723
|
+
# @return [String]
|
4724
|
+
#
|
4725
|
+
# @!attribute [rw] max_results
|
4726
|
+
# The maximum number of results to return for each paginated request.
|
4727
|
+
# If not specified, the default value is 50.
|
4728
|
+
# @return [Integer]
|
4729
|
+
#
|
4730
|
+
# @!attribute [rw] filter
|
4731
|
+
# Filters the requested list of asset model properties. You can choose
|
4732
|
+
# one of the following options:
|
4733
|
+
#
|
4734
|
+
# * `ALL` – The list includes all asset model properties for a given
|
4735
|
+
# asset model ID.
|
4736
|
+
#
|
4737
|
+
# * `BASE` – The list includes only base asset model properties for a
|
4738
|
+
# given asset model ID.
|
4739
|
+
#
|
4740
|
+
# Default: `BASE`
|
4741
|
+
# @return [String]
|
4742
|
+
#
|
4743
|
+
class ListAssetModelPropertiesRequest < Struct.new(
|
4744
|
+
:asset_model_id,
|
4745
|
+
:next_token,
|
4746
|
+
:max_results,
|
4747
|
+
:filter)
|
4748
|
+
SENSITIVE = []
|
4749
|
+
include Aws::Structure
|
4750
|
+
end
|
4751
|
+
|
4752
|
+
# @!attribute [rw] asset_model_property_summaries
|
4753
|
+
# A list that summarizes the properties associated with the specified
|
4754
|
+
# asset model.
|
4755
|
+
# @return [Array<Types::AssetModelPropertySummary>]
|
5752
4756
|
#
|
5753
|
-
#
|
5754
|
-
#
|
5755
|
-
#
|
5756
|
-
#
|
4757
|
+
# @!attribute [rw] next_token
|
4758
|
+
# The token for the next set of results, or null if there are no
|
4759
|
+
# additional results.
|
4760
|
+
# @return [String]
|
5757
4761
|
#
|
4762
|
+
class ListAssetModelPropertiesResponse < Struct.new(
|
4763
|
+
:asset_model_property_summaries,
|
4764
|
+
:next_token)
|
4765
|
+
SENSITIVE = []
|
4766
|
+
include Aws::Structure
|
4767
|
+
end
|
4768
|
+
|
5758
4769
|
# @!attribute [rw] next_token
|
5759
4770
|
# The token to be used for the next set of paginated results.
|
5760
4771
|
# @return [String]
|
@@ -5788,16 +4799,58 @@ module Aws::IoTSiteWise
|
|
5788
4799
|
include Aws::Structure
|
5789
4800
|
end
|
5790
4801
|
|
5791
|
-
#
|
5792
|
-
#
|
4802
|
+
# @!attribute [rw] asset_id
|
4803
|
+
# The ID of the asset.
|
4804
|
+
# @return [String]
|
4805
|
+
#
|
4806
|
+
# @!attribute [rw] next_token
|
4807
|
+
# The token to be used for the next set of paginated results.
|
4808
|
+
# @return [String]
|
4809
|
+
#
|
4810
|
+
# @!attribute [rw] max_results
|
4811
|
+
# The maximum number of results to return for each paginated request.
|
4812
|
+
# If not specified, the default value is 50.
|
4813
|
+
# @return [Integer]
|
5793
4814
|
#
|
5794
|
-
#
|
5795
|
-
#
|
5796
|
-
#
|
5797
|
-
# next_token: "NextToken",
|
5798
|
-
# max_results: 1,
|
5799
|
-
# }
|
4815
|
+
# @!attribute [rw] filter
|
4816
|
+
# Filters the requested list of asset properties. You can choose one
|
4817
|
+
# of the following options:
|
5800
4818
|
#
|
4819
|
+
# * `ALL` – The list includes all asset properties for a given asset
|
4820
|
+
# model ID.
|
4821
|
+
#
|
4822
|
+
# * `BASE` – The list includes only base asset properties for a given
|
4823
|
+
# asset model ID.
|
4824
|
+
#
|
4825
|
+
# Default: `BASE`
|
4826
|
+
# @return [String]
|
4827
|
+
#
|
4828
|
+
class ListAssetPropertiesRequest < Struct.new(
|
4829
|
+
:asset_id,
|
4830
|
+
:next_token,
|
4831
|
+
:max_results,
|
4832
|
+
:filter)
|
4833
|
+
SENSITIVE = []
|
4834
|
+
include Aws::Structure
|
4835
|
+
end
|
4836
|
+
|
4837
|
+
# @!attribute [rw] asset_property_summaries
|
4838
|
+
# A list that summarizes the properties associated with the specified
|
4839
|
+
# asset.
|
4840
|
+
# @return [Array<Types::AssetPropertySummary>]
|
4841
|
+
#
|
4842
|
+
# @!attribute [rw] next_token
|
4843
|
+
# The token for the next set of results, or null if there are no
|
4844
|
+
# additional results.
|
4845
|
+
# @return [String]
|
4846
|
+
#
|
4847
|
+
class ListAssetPropertiesResponse < Struct.new(
|
4848
|
+
:asset_property_summaries,
|
4849
|
+
:next_token)
|
4850
|
+
SENSITIVE = []
|
4851
|
+
include Aws::Structure
|
4852
|
+
end
|
4853
|
+
|
5801
4854
|
# @!attribute [rw] asset_id
|
5802
4855
|
# The ID of the asset.
|
5803
4856
|
# @return [String]
|
@@ -5847,16 +4900,6 @@ module Aws::IoTSiteWise
|
|
5847
4900
|
include Aws::Structure
|
5848
4901
|
end
|
5849
4902
|
|
5850
|
-
# @note When making an API call, you may pass ListAssetsRequest
|
5851
|
-
# data as a hash:
|
5852
|
-
#
|
5853
|
-
# {
|
5854
|
-
# next_token: "NextToken",
|
5855
|
-
# max_results: 1,
|
5856
|
-
# asset_model_id: "ID",
|
5857
|
-
# filter: "ALL", # accepts ALL, TOP_LEVEL
|
5858
|
-
# }
|
5859
|
-
#
|
5860
4903
|
# @!attribute [rw] next_token
|
5861
4904
|
# The token to be used for the next set of paginated results.
|
5862
4905
|
# @return [String]
|
@@ -5910,17 +4953,6 @@ module Aws::IoTSiteWise
|
|
5910
4953
|
include Aws::Structure
|
5911
4954
|
end
|
5912
4955
|
|
5913
|
-
# @note When making an API call, you may pass ListAssociatedAssetsRequest
|
5914
|
-
# data as a hash:
|
5915
|
-
#
|
5916
|
-
# {
|
5917
|
-
# asset_id: "ID", # required
|
5918
|
-
# hierarchy_id: "ID",
|
5919
|
-
# traversal_direction: "PARENT", # accepts PARENT, CHILD
|
5920
|
-
# next_token: "NextToken",
|
5921
|
-
# max_results: 1,
|
5922
|
-
# }
|
5923
|
-
#
|
5924
4956
|
# @!attribute [rw] asset_id
|
5925
4957
|
# The ID of the asset to query.
|
5926
4958
|
# @return [String]
|
@@ -5990,15 +5022,6 @@ module Aws::IoTSiteWise
|
|
5990
5022
|
include Aws::Structure
|
5991
5023
|
end
|
5992
5024
|
|
5993
|
-
# @note When making an API call, you may pass ListBulkImportJobsRequest
|
5994
|
-
# data as a hash:
|
5995
|
-
#
|
5996
|
-
# {
|
5997
|
-
# next_token: "NextToken",
|
5998
|
-
# max_results: 1,
|
5999
|
-
# filter: "ALL", # accepts ALL, PENDING, RUNNING, CANCELLED, FAILED, COMPLETED_WITH_FAILURES, COMPLETED
|
6000
|
-
# }
|
6001
|
-
#
|
6002
5025
|
# @!attribute [rw] next_token
|
6003
5026
|
# The token to be used for the next set of paginated results.
|
6004
5027
|
# @return [String]
|
@@ -6036,15 +5059,6 @@ module Aws::IoTSiteWise
|
|
6036
5059
|
include Aws::Structure
|
6037
5060
|
end
|
6038
5061
|
|
6039
|
-
# @note When making an API call, you may pass ListDashboardsRequest
|
6040
|
-
# data as a hash:
|
6041
|
-
#
|
6042
|
-
# {
|
6043
|
-
# project_id: "ID", # required
|
6044
|
-
# next_token: "NextToken",
|
6045
|
-
# max_results: 1,
|
6046
|
-
# }
|
6047
|
-
#
|
6048
5062
|
# @!attribute [rw] project_id
|
6049
5063
|
# The ID of the project.
|
6050
5064
|
# @return [String]
|
@@ -6083,14 +5097,6 @@ module Aws::IoTSiteWise
|
|
6083
5097
|
include Aws::Structure
|
6084
5098
|
end
|
6085
5099
|
|
6086
|
-
# @note When making an API call, you may pass ListGatewaysRequest
|
6087
|
-
# data as a hash:
|
6088
|
-
#
|
6089
|
-
# {
|
6090
|
-
# next_token: "NextToken",
|
6091
|
-
# max_results: 1,
|
6092
|
-
# }
|
6093
|
-
#
|
6094
5100
|
# @!attribute [rw] next_token
|
6095
5101
|
# The token to be used for the next set of paginated results.
|
6096
5102
|
# @return [String]
|
@@ -6124,14 +5130,6 @@ module Aws::IoTSiteWise
|
|
6124
5130
|
include Aws::Structure
|
6125
5131
|
end
|
6126
5132
|
|
6127
|
-
# @note When making an API call, you may pass ListPortalsRequest
|
6128
|
-
# data as a hash:
|
6129
|
-
#
|
6130
|
-
# {
|
6131
|
-
# next_token: "NextToken",
|
6132
|
-
# max_results: 1,
|
6133
|
-
# }
|
6134
|
-
#
|
6135
5133
|
# @!attribute [rw] next_token
|
6136
5134
|
# The token to be used for the next set of paginated results.
|
6137
5135
|
# @return [String]
|
@@ -6165,15 +5163,6 @@ module Aws::IoTSiteWise
|
|
6165
5163
|
include Aws::Structure
|
6166
5164
|
end
|
6167
5165
|
|
6168
|
-
# @note When making an API call, you may pass ListProjectAssetsRequest
|
6169
|
-
# data as a hash:
|
6170
|
-
#
|
6171
|
-
# {
|
6172
|
-
# project_id: "ID", # required
|
6173
|
-
# next_token: "NextToken",
|
6174
|
-
# max_results: 1,
|
6175
|
-
# }
|
6176
|
-
#
|
6177
5166
|
# @!attribute [rw] project_id
|
6178
5167
|
# The ID of the project.
|
6179
5168
|
# @return [String]
|
@@ -6213,15 +5202,6 @@ module Aws::IoTSiteWise
|
|
6213
5202
|
include Aws::Structure
|
6214
5203
|
end
|
6215
5204
|
|
6216
|
-
# @note When making an API call, you may pass ListProjectsRequest
|
6217
|
-
# data as a hash:
|
6218
|
-
#
|
6219
|
-
# {
|
6220
|
-
# portal_id: "ID", # required
|
6221
|
-
# next_token: "NextToken",
|
6222
|
-
# max_results: 1,
|
6223
|
-
# }
|
6224
|
-
#
|
6225
5205
|
# @!attribute [rw] portal_id
|
6226
5206
|
# The ID of the portal.
|
6227
5207
|
# @return [String]
|
@@ -6260,13 +5240,6 @@ module Aws::IoTSiteWise
|
|
6260
5240
|
include Aws::Structure
|
6261
5241
|
end
|
6262
5242
|
|
6263
|
-
# @note When making an API call, you may pass ListTagsForResourceRequest
|
6264
|
-
# data as a hash:
|
6265
|
-
#
|
6266
|
-
# {
|
6267
|
-
# resource_arn: "AmazonResourceName", # required
|
6268
|
-
# }
|
6269
|
-
#
|
6270
5243
|
# @!attribute [rw] resource_arn
|
6271
5244
|
# The [ARN][1] of the resource.
|
6272
5245
|
#
|
@@ -6297,17 +5270,6 @@ module Aws::IoTSiteWise
|
|
6297
5270
|
include Aws::Structure
|
6298
5271
|
end
|
6299
5272
|
|
6300
|
-
# @note When making an API call, you may pass ListTimeSeriesRequest
|
6301
|
-
# data as a hash:
|
6302
|
-
#
|
6303
|
-
# {
|
6304
|
-
# next_token: "NextToken",
|
6305
|
-
# max_results: 1,
|
6306
|
-
# asset_id: "ID",
|
6307
|
-
# alias_prefix: "PropertyAlias",
|
6308
|
-
# time_series_type: "ASSOCIATED", # accepts ASSOCIATED, DISASSOCIATED
|
6309
|
-
# }
|
6310
|
-
#
|
6311
5273
|
# @!attribute [rw] next_token
|
6312
5274
|
# The token to be used for the next set of paginated results.
|
6313
5275
|
# @return [String]
|
@@ -6363,13 +5325,6 @@ module Aws::IoTSiteWise
|
|
6363
5325
|
|
6364
5326
|
# Contains logging options.
|
6365
5327
|
#
|
6366
|
-
# @note When making an API call, you may pass LoggingOptions
|
6367
|
-
# data as a hash:
|
6368
|
-
#
|
6369
|
-
# {
|
6370
|
-
# level: "ERROR", # required, accepts ERROR, INFO, OFF
|
6371
|
-
# }
|
6372
|
-
#
|
6373
5328
|
# @!attribute [rw] level
|
6374
5329
|
# The IoT SiteWise logging verbosity level.
|
6375
5330
|
# @return [String]
|
@@ -6387,17 +5342,6 @@ module Aws::IoTSiteWise
|
|
6387
5342
|
#
|
6388
5343
|
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html#measurements
|
6389
5344
|
#
|
6390
|
-
# @note When making an API call, you may pass Measurement
|
6391
|
-
# data as a hash:
|
6392
|
-
#
|
6393
|
-
# {
|
6394
|
-
# processing_config: {
|
6395
|
-
# forwarding_config: { # required
|
6396
|
-
# state: "DISABLED", # required, accepts DISABLED, ENABLED
|
6397
|
-
# },
|
6398
|
-
# },
|
6399
|
-
# }
|
6400
|
-
#
|
6401
5345
|
# @!attribute [rw] processing_config
|
6402
5346
|
# The processing configuration for the given measurement property. You
|
6403
5347
|
# can configure measurements to be kept at the edge or forwarded to
|
@@ -6416,15 +5360,6 @@ module Aws::IoTSiteWise
|
|
6416
5360
|
# Amazon Web Services Cloud. By default, measurements are forwarded to
|
6417
5361
|
# the cloud.
|
6418
5362
|
#
|
6419
|
-
# @note When making an API call, you may pass MeasurementProcessingConfig
|
6420
|
-
# data as a hash:
|
6421
|
-
#
|
6422
|
-
# {
|
6423
|
-
# forwarding_config: { # required
|
6424
|
-
# state: "DISABLED", # required, accepts DISABLED, ENABLED
|
6425
|
-
# },
|
6426
|
-
# }
|
6427
|
-
#
|
6428
5363
|
# @!attribute [rw] forwarding_config
|
6429
5364
|
# The forwarding configuration for the given measurement property.
|
6430
5365
|
# @return [Types::ForwardingConfig]
|
@@ -6453,31 +5388,6 @@ module Aws::IoTSiteWise
|
|
6453
5388
|
#
|
6454
5389
|
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html#metrics
|
6455
5390
|
#
|
6456
|
-
# @note When making an API call, you may pass Metric
|
6457
|
-
# data as a hash:
|
6458
|
-
#
|
6459
|
-
# {
|
6460
|
-
# expression: "Expression", # required
|
6461
|
-
# variables: [ # required
|
6462
|
-
# {
|
6463
|
-
# name: "VariableName", # required
|
6464
|
-
# value: { # required
|
6465
|
-
# property_id: "Macro", # required
|
6466
|
-
# hierarchy_id: "Macro",
|
6467
|
-
# },
|
6468
|
-
# },
|
6469
|
-
# ],
|
6470
|
-
# window: { # required
|
6471
|
-
# tumbling: {
|
6472
|
-
# interval: "Interval", # required
|
6473
|
-
# offset: "Offset",
|
6474
|
-
# },
|
6475
|
-
# },
|
6476
|
-
# processing_config: {
|
6477
|
-
# compute_location: "EDGE", # required, accepts EDGE, CLOUD
|
6478
|
-
# },
|
6479
|
-
# }
|
6480
|
-
#
|
6481
5391
|
# @!attribute [rw] expression
|
6482
5392
|
# The mathematical expression that defines the metric aggregation
|
6483
5393
|
# function. You can specify up to 10 variables per expression. You can
|
@@ -6520,13 +5430,6 @@ module Aws::IoTSiteWise
|
|
6520
5430
|
# configure metrics to be computed at the edge or in the Amazon Web
|
6521
5431
|
# Services Cloud. By default, metrics are forwarded to the cloud.
|
6522
5432
|
#
|
6523
|
-
# @note When making an API call, you may pass MetricProcessingConfig
|
6524
|
-
# data as a hash:
|
6525
|
-
#
|
6526
|
-
# {
|
6527
|
-
# compute_location: "EDGE", # required, accepts EDGE, CLOUD
|
6528
|
-
# }
|
6529
|
-
#
|
6530
5433
|
# @!attribute [rw] compute_location
|
6531
5434
|
# The compute location for the given metric property.
|
6532
5435
|
# @return [String]
|
@@ -6540,16 +5443,6 @@ module Aws::IoTSiteWise
|
|
6540
5443
|
# Contains a time interval window used for data aggregate computations
|
6541
5444
|
# (for example, average, sum, count, and so on).
|
6542
5445
|
#
|
6543
|
-
# @note When making an API call, you may pass MetricWindow
|
6544
|
-
# data as a hash:
|
6545
|
-
#
|
6546
|
-
# {
|
6547
|
-
# tumbling: {
|
6548
|
-
# interval: "Interval", # required
|
6549
|
-
# offset: "Offset",
|
6550
|
-
# },
|
6551
|
-
# }
|
6552
|
-
#
|
6553
5446
|
# @!attribute [rw] tumbling
|
6554
5447
|
# The tumbling time interval window.
|
6555
5448
|
# @return [Types::TumblingWindow]
|
@@ -6579,16 +5472,6 @@ module Aws::IoTSiteWise
|
|
6579
5472
|
|
6580
5473
|
# Contains information about the storage destination.
|
6581
5474
|
#
|
6582
|
-
# @note When making an API call, you may pass MultiLayerStorage
|
6583
|
-
# data as a hash:
|
6584
|
-
#
|
6585
|
-
# {
|
6586
|
-
# customer_managed_s3_storage: { # required
|
6587
|
-
# s3_resource_arn: "ARN", # required
|
6588
|
-
# role_arn: "ARN", # required
|
6589
|
-
# },
|
6590
|
-
# }
|
6591
|
-
#
|
6592
5475
|
# @!attribute [rw] customer_managed_s3_storage
|
6593
5476
|
# Contains information about a customer managed Amazon S3 bucket.
|
6594
5477
|
# @return [Types::CustomerManagedS3Storage]
|
@@ -6601,13 +5484,6 @@ module Aws::IoTSiteWise
|
|
6601
5484
|
|
6602
5485
|
# Identifies an IoT SiteWise Monitor portal.
|
6603
5486
|
#
|
6604
|
-
# @note When making an API call, you may pass PortalResource
|
6605
|
-
# data as a hash:
|
6606
|
-
#
|
6607
|
-
# {
|
6608
|
-
# id: "ID", # required
|
6609
|
-
# }
|
6610
|
-
#
|
6611
5487
|
# @!attribute [rw] id
|
6612
5488
|
# The ID of the portal.
|
6613
5489
|
# @return [String]
|
@@ -6651,8 +5527,8 @@ module Aws::IoTSiteWise
|
|
6651
5527
|
#
|
6652
5528
|
# @!attribute [rw] start_url
|
6653
5529
|
# The URL for the IoT SiteWise Monitor portal. You can use this URL to
|
6654
|
-
# access portals that use
|
6655
|
-
#
|
5530
|
+
# access portals that use IAM Identity Center for authentication. For
|
5531
|
+
# portals that use IAM for authentication, you must use the IoT
|
6656
5532
|
# SiteWise console to get a URL that you can use to access the portal.
|
6657
5533
|
# @return [String]
|
6658
5534
|
#
|
@@ -6695,13 +5571,6 @@ module Aws::IoTSiteWise
|
|
6695
5571
|
|
6696
5572
|
# Identifies a specific IoT SiteWise Monitor project.
|
6697
5573
|
#
|
6698
|
-
# @note When making an API call, you may pass ProjectResource
|
6699
|
-
# data as a hash:
|
6700
|
-
#
|
6701
|
-
# {
|
6702
|
-
# id: "ID", # required
|
6703
|
-
# }
|
6704
|
-
#
|
6705
5574
|
# @!attribute [rw] id
|
6706
5575
|
# The ID of the project.
|
6707
5576
|
# @return [String]
|
@@ -6828,61 +5697,6 @@ module Aws::IoTSiteWise
|
|
6828
5697
|
# Contains a property type, which can be one of `attribute`,
|
6829
5698
|
# `measurement`, `metric`, or `transform`.
|
6830
5699
|
#
|
6831
|
-
# @note When making an API call, you may pass PropertyType
|
6832
|
-
# data as a hash:
|
6833
|
-
#
|
6834
|
-
# {
|
6835
|
-
# attribute: {
|
6836
|
-
# default_value: "DefaultValue",
|
6837
|
-
# },
|
6838
|
-
# measurement: {
|
6839
|
-
# processing_config: {
|
6840
|
-
# forwarding_config: { # required
|
6841
|
-
# state: "DISABLED", # required, accepts DISABLED, ENABLED
|
6842
|
-
# },
|
6843
|
-
# },
|
6844
|
-
# },
|
6845
|
-
# transform: {
|
6846
|
-
# expression: "Expression", # required
|
6847
|
-
# variables: [ # required
|
6848
|
-
# {
|
6849
|
-
# name: "VariableName", # required
|
6850
|
-
# value: { # required
|
6851
|
-
# property_id: "Macro", # required
|
6852
|
-
# hierarchy_id: "Macro",
|
6853
|
-
# },
|
6854
|
-
# },
|
6855
|
-
# ],
|
6856
|
-
# processing_config: {
|
6857
|
-
# compute_location: "EDGE", # required, accepts EDGE, CLOUD
|
6858
|
-
# forwarding_config: {
|
6859
|
-
# state: "DISABLED", # required, accepts DISABLED, ENABLED
|
6860
|
-
# },
|
6861
|
-
# },
|
6862
|
-
# },
|
6863
|
-
# metric: {
|
6864
|
-
# expression: "Expression", # required
|
6865
|
-
# variables: [ # required
|
6866
|
-
# {
|
6867
|
-
# name: "VariableName", # required
|
6868
|
-
# value: { # required
|
6869
|
-
# property_id: "Macro", # required
|
6870
|
-
# hierarchy_id: "Macro",
|
6871
|
-
# },
|
6872
|
-
# },
|
6873
|
-
# ],
|
6874
|
-
# window: { # required
|
6875
|
-
# tumbling: {
|
6876
|
-
# interval: "Interval", # required
|
6877
|
-
# offset: "Offset",
|
6878
|
-
# },
|
6879
|
-
# },
|
6880
|
-
# processing_config: {
|
6881
|
-
# compute_location: "EDGE", # required, accepts EDGE, CLOUD
|
6882
|
-
# },
|
6883
|
-
# },
|
6884
|
-
# }
|
6885
|
-
#
|
6886
5700
|
# @!attribute [rw] attribute
|
6887
5701
|
# Specifies an asset attribute property. An attribute generally
|
6888
5702
|
# contains static information, such as the serial number of an
|
@@ -6930,31 +5744,6 @@ module Aws::IoTSiteWise
|
|
6930
5744
|
#
|
6931
5745
|
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchPutAssetPropertyValue.html
|
6932
5746
|
#
|
6933
|
-
# @note When making an API call, you may pass PutAssetPropertyValueEntry
|
6934
|
-
# data as a hash:
|
6935
|
-
#
|
6936
|
-
# {
|
6937
|
-
# entry_id: "EntryId", # required
|
6938
|
-
# asset_id: "ID",
|
6939
|
-
# property_id: "ID",
|
6940
|
-
# property_alias: "AssetPropertyAlias",
|
6941
|
-
# property_values: [ # required
|
6942
|
-
# {
|
6943
|
-
# value: { # required
|
6944
|
-
# string_value: "PropertyValueStringValue",
|
6945
|
-
# integer_value: 1,
|
6946
|
-
# double_value: 1.0,
|
6947
|
-
# boolean_value: false,
|
6948
|
-
# },
|
6949
|
-
# timestamp: { # required
|
6950
|
-
# time_in_seconds: 1, # required
|
6951
|
-
# offset_in_nanos: 1,
|
6952
|
-
# },
|
6953
|
-
# quality: "GOOD", # accepts GOOD, BAD, UNCERTAIN
|
6954
|
-
# },
|
6955
|
-
# ],
|
6956
|
-
# }
|
6957
|
-
#
|
6958
5747
|
# @!attribute [rw] entry_id
|
6959
5748
|
# The user specified ID for the entry. You can use this ID to identify
|
6960
5749
|
# which entries failed.
|
@@ -6995,14 +5784,6 @@ module Aws::IoTSiteWise
|
|
6995
5784
|
include Aws::Structure
|
6996
5785
|
end
|
6997
5786
|
|
6998
|
-
# @note When making an API call, you may pass PutDefaultEncryptionConfigurationRequest
|
6999
|
-
# data as a hash:
|
7000
|
-
#
|
7001
|
-
# {
|
7002
|
-
# encryption_type: "SITEWISE_DEFAULT_ENCRYPTION", # required, accepts SITEWISE_DEFAULT_ENCRYPTION, KMS_BASED_ENCRYPTION
|
7003
|
-
# kms_key_id: "KmsKeyId",
|
7004
|
-
# }
|
7005
|
-
#
|
7006
5787
|
# @!attribute [rw] encryption_type
|
7007
5788
|
# The type of encryption used for the encryption configuration.
|
7008
5789
|
# @return [String]
|
@@ -7042,15 +5823,6 @@ module Aws::IoTSiteWise
|
|
7042
5823
|
include Aws::Structure
|
7043
5824
|
end
|
7044
5825
|
|
7045
|
-
# @note When making an API call, you may pass PutLoggingOptionsRequest
|
7046
|
-
# data as a hash:
|
7047
|
-
#
|
7048
|
-
# {
|
7049
|
-
# logging_options: { # required
|
7050
|
-
# level: "ERROR", # required, accepts ERROR, INFO, OFF
|
7051
|
-
# },
|
7052
|
-
# }
|
7053
|
-
#
|
7054
5826
|
# @!attribute [rw] logging_options
|
7055
5827
|
# The logging options to set.
|
7056
5828
|
# @return [Types::LoggingOptions]
|
@@ -7063,24 +5835,6 @@ module Aws::IoTSiteWise
|
|
7063
5835
|
|
7064
5836
|
class PutLoggingOptionsResponse < Aws::EmptyStructure; end
|
7065
5837
|
|
7066
|
-
# @note When making an API call, you may pass PutStorageConfigurationRequest
|
7067
|
-
# data as a hash:
|
7068
|
-
#
|
7069
|
-
# {
|
7070
|
-
# storage_type: "SITEWISE_DEFAULT_STORAGE", # required, accepts SITEWISE_DEFAULT_STORAGE, MULTI_LAYER_STORAGE
|
7071
|
-
# multi_layer_storage: {
|
7072
|
-
# customer_managed_s3_storage: { # required
|
7073
|
-
# s3_resource_arn: "ARN", # required
|
7074
|
-
# role_arn: "ARN", # required
|
7075
|
-
# },
|
7076
|
-
# },
|
7077
|
-
# disassociated_data_storage: "ENABLED", # accepts ENABLED, DISABLED
|
7078
|
-
# retention_period: {
|
7079
|
-
# number_of_days: 1,
|
7080
|
-
# unlimited: false,
|
7081
|
-
# },
|
7082
|
-
# }
|
7083
|
-
#
|
7084
5838
|
# @!attribute [rw] storage_type
|
7085
5839
|
# The storage tier that you specified for your data. The `storageType`
|
7086
5840
|
# parameter can be one of the following values:
|
@@ -7194,18 +5948,6 @@ module Aws::IoTSiteWise
|
|
7194
5948
|
|
7195
5949
|
# Contains an IoT SiteWise Monitor resource ID for a portal or project.
|
7196
5950
|
#
|
7197
|
-
# @note When making an API call, you may pass Resource
|
7198
|
-
# data as a hash:
|
7199
|
-
#
|
7200
|
-
# {
|
7201
|
-
# portal: {
|
7202
|
-
# id: "ID", # required
|
7203
|
-
# },
|
7204
|
-
# project: {
|
7205
|
-
# id: "ID", # required
|
7206
|
-
# },
|
7207
|
-
# }
|
7208
|
-
#
|
7209
5951
|
# @!attribute [rw] portal
|
7210
5952
|
# A portal resource.
|
7211
5953
|
# @return [Types::PortalResource]
|
@@ -7256,14 +5998,6 @@ module Aws::IoTSiteWise
|
|
7256
5998
|
# How many days your data is kept in the hot tier. By default, your data
|
7257
5999
|
# is kept indefinitely in the hot tier.
|
7258
6000
|
#
|
7259
|
-
# @note When making an API call, you may pass RetentionPeriod
|
7260
|
-
# data as a hash:
|
7261
|
-
#
|
7262
|
-
# {
|
7263
|
-
# number_of_days: 1,
|
7264
|
-
# unlimited: false,
|
7265
|
-
# }
|
7266
|
-
#
|
7267
6001
|
# @!attribute [rw] number_of_days
|
7268
6002
|
# The number of days that your data is kept.
|
7269
6003
|
#
|
@@ -7300,16 +6034,6 @@ module Aws::IoTSiteWise
|
|
7300
6034
|
include Aws::Structure
|
7301
6035
|
end
|
7302
6036
|
|
7303
|
-
# @note When making an API call, you may pass TagResourceRequest
|
7304
|
-
# data as a hash:
|
7305
|
-
#
|
7306
|
-
# {
|
7307
|
-
# resource_arn: "AmazonResourceName", # required
|
7308
|
-
# tags: { # required
|
7309
|
-
# "TagKey" => "TagValue",
|
7310
|
-
# },
|
7311
|
-
# }
|
7312
|
-
#
|
7313
6037
|
# @!attribute [rw] resource_arn
|
7314
6038
|
# The [ARN][1] of the resource to tag.
|
7315
6039
|
#
|
@@ -7359,14 +6083,6 @@ module Aws::IoTSiteWise
|
|
7359
6083
|
|
7360
6084
|
# Contains a timestamp with optional nanosecond granularity.
|
7361
6085
|
#
|
7362
|
-
# @note When making an API call, you may pass TimeInNanos
|
7363
|
-
# data as a hash:
|
7364
|
-
#
|
7365
|
-
# {
|
7366
|
-
# time_in_seconds: 1, # required
|
7367
|
-
# offset_in_nanos: 1,
|
7368
|
-
# }
|
7369
|
-
#
|
7370
6086
|
# @!attribute [rw] time_in_seconds
|
7371
6087
|
# The timestamp date, in seconds, in the Unix epoch format. Fractional
|
7372
6088
|
# nanosecond data is provided by `offsetInNanos`.
|
@@ -7476,28 +6192,6 @@ module Aws::IoTSiteWise
|
|
7476
6192
|
#
|
7477
6193
|
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html#transforms
|
7478
6194
|
#
|
7479
|
-
# @note When making an API call, you may pass Transform
|
7480
|
-
# data as a hash:
|
7481
|
-
#
|
7482
|
-
# {
|
7483
|
-
# expression: "Expression", # required
|
7484
|
-
# variables: [ # required
|
7485
|
-
# {
|
7486
|
-
# name: "VariableName", # required
|
7487
|
-
# value: { # required
|
7488
|
-
# property_id: "Macro", # required
|
7489
|
-
# hierarchy_id: "Macro",
|
7490
|
-
# },
|
7491
|
-
# },
|
7492
|
-
# ],
|
7493
|
-
# processing_config: {
|
7494
|
-
# compute_location: "EDGE", # required, accepts EDGE, CLOUD
|
7495
|
-
# forwarding_config: {
|
7496
|
-
# state: "DISABLED", # required, accepts DISABLED, ENABLED
|
7497
|
-
# },
|
7498
|
-
# },
|
7499
|
-
# }
|
7500
|
-
#
|
7501
6195
|
# @!attribute [rw] expression
|
7502
6196
|
# The mathematical expression that defines the transformation
|
7503
6197
|
# function. You can specify up to 10 variables per expression. You can
|
@@ -7535,16 +6229,6 @@ module Aws::IoTSiteWise
|
|
7535
6229
|
# Web Services Cloud. You can also configure transforms to be computed
|
7536
6230
|
# at the edge or in the cloud.
|
7537
6231
|
#
|
7538
|
-
# @note When making an API call, you may pass TransformProcessingConfig
|
7539
|
-
# data as a hash:
|
7540
|
-
#
|
7541
|
-
# {
|
7542
|
-
# compute_location: "EDGE", # required, accepts EDGE, CLOUD
|
7543
|
-
# forwarding_config: {
|
7544
|
-
# state: "DISABLED", # required, accepts DISABLED, ENABLED
|
7545
|
-
# },
|
7546
|
-
# }
|
7547
|
-
#
|
7548
6232
|
# @!attribute [rw] compute_location
|
7549
6233
|
# The compute location for the given transform property.
|
7550
6234
|
# @return [String]
|
@@ -7577,14 +6261,6 @@ module Aws::IoTSiteWise
|
|
7577
6261
|
#
|
7578
6262
|
# [1]: https://en.wikipedia.org/wiki/ISO_8601
|
7579
6263
|
#
|
7580
|
-
# @note When making an API call, you may pass TumblingWindow
|
7581
|
-
# data as a hash:
|
7582
|
-
#
|
7583
|
-
# {
|
7584
|
-
# interval: "Interval", # required
|
7585
|
-
# offset: "Offset",
|
7586
|
-
# }
|
7587
|
-
#
|
7588
6264
|
# @!attribute [rw] interval
|
7589
6265
|
# The time interval for the tumbling window. The interval time must be
|
7590
6266
|
# between 1 minute and 1 week.
|
@@ -7669,14 +6345,6 @@ module Aws::IoTSiteWise
|
|
7669
6345
|
include Aws::Structure
|
7670
6346
|
end
|
7671
6347
|
|
7672
|
-
# @note When making an API call, you may pass UntagResourceRequest
|
7673
|
-
# data as a hash:
|
7674
|
-
#
|
7675
|
-
# {
|
7676
|
-
# resource_arn: "AmazonResourceName", # required
|
7677
|
-
# tag_keys: ["TagKey"], # required
|
7678
|
-
# }
|
7679
|
-
#
|
7680
6348
|
# @!attribute [rw] resource_arn
|
7681
6349
|
# The [ARN][1] of the resource to untag.
|
7682
6350
|
#
|
@@ -7698,44 +6366,13 @@ module Aws::IoTSiteWise
|
|
7698
6366
|
|
7699
6367
|
class UntagResourceResponse < Aws::EmptyStructure; end
|
7700
6368
|
|
7701
|
-
# @note When making an API call, you may pass UpdateAccessPolicyRequest
|
7702
|
-
# data as a hash:
|
7703
|
-
#
|
7704
|
-
# {
|
7705
|
-
# access_policy_id: "ID", # required
|
7706
|
-
# access_policy_identity: { # required
|
7707
|
-
# user: {
|
7708
|
-
# id: "IdentityId", # required
|
7709
|
-
# },
|
7710
|
-
# group: {
|
7711
|
-
# id: "IdentityId", # required
|
7712
|
-
# },
|
7713
|
-
# iam_user: {
|
7714
|
-
# arn: "ARN", # required
|
7715
|
-
# },
|
7716
|
-
# iam_role: {
|
7717
|
-
# arn: "ARN", # required
|
7718
|
-
# },
|
7719
|
-
# },
|
7720
|
-
# access_policy_resource: { # required
|
7721
|
-
# portal: {
|
7722
|
-
# id: "ID", # required
|
7723
|
-
# },
|
7724
|
-
# project: {
|
7725
|
-
# id: "ID", # required
|
7726
|
-
# },
|
7727
|
-
# },
|
7728
|
-
# access_policy_permission: "ADMINISTRATOR", # required, accepts ADMINISTRATOR, VIEWER
|
7729
|
-
# client_token: "ClientToken",
|
7730
|
-
# }
|
7731
|
-
#
|
7732
6369
|
# @!attribute [rw] access_policy_id
|
7733
6370
|
# The ID of the access policy.
|
7734
6371
|
# @return [String]
|
7735
6372
|
#
|
7736
6373
|
# @!attribute [rw] access_policy_identity
|
7737
|
-
# The identity for this access policy. Choose an
|
7738
|
-
#
|
6374
|
+
# The identity for this access policy. Choose an IAM Identity Center
|
6375
|
+
# user, an IAM Identity Center group, or an IAM user.
|
7739
6376
|
# @return [Types::Identity]
|
7740
6377
|
#
|
7741
6378
|
# @!attribute [rw] access_policy_resource
|
@@ -7769,150 +6406,6 @@ module Aws::IoTSiteWise
|
|
7769
6406
|
|
7770
6407
|
class UpdateAccessPolicyResponse < Aws::EmptyStructure; end
|
7771
6408
|
|
7772
|
-
# @note When making an API call, you may pass UpdateAssetModelRequest
|
7773
|
-
# data as a hash:
|
7774
|
-
#
|
7775
|
-
# {
|
7776
|
-
# asset_model_id: "ID", # required
|
7777
|
-
# asset_model_name: "Name", # required
|
7778
|
-
# asset_model_description: "Description",
|
7779
|
-
# asset_model_properties: [
|
7780
|
-
# {
|
7781
|
-
# id: "ID",
|
7782
|
-
# name: "Name", # required
|
7783
|
-
# data_type: "STRING", # required, accepts STRING, INTEGER, DOUBLE, BOOLEAN, STRUCT
|
7784
|
-
# data_type_spec: "Name",
|
7785
|
-
# unit: "PropertyUnit",
|
7786
|
-
# type: { # required
|
7787
|
-
# attribute: {
|
7788
|
-
# default_value: "DefaultValue",
|
7789
|
-
# },
|
7790
|
-
# measurement: {
|
7791
|
-
# processing_config: {
|
7792
|
-
# forwarding_config: { # required
|
7793
|
-
# state: "DISABLED", # required, accepts DISABLED, ENABLED
|
7794
|
-
# },
|
7795
|
-
# },
|
7796
|
-
# },
|
7797
|
-
# transform: {
|
7798
|
-
# expression: "Expression", # required
|
7799
|
-
# variables: [ # required
|
7800
|
-
# {
|
7801
|
-
# name: "VariableName", # required
|
7802
|
-
# value: { # required
|
7803
|
-
# property_id: "Macro", # required
|
7804
|
-
# hierarchy_id: "Macro",
|
7805
|
-
# },
|
7806
|
-
# },
|
7807
|
-
# ],
|
7808
|
-
# processing_config: {
|
7809
|
-
# compute_location: "EDGE", # required, accepts EDGE, CLOUD
|
7810
|
-
# forwarding_config: {
|
7811
|
-
# state: "DISABLED", # required, accepts DISABLED, ENABLED
|
7812
|
-
# },
|
7813
|
-
# },
|
7814
|
-
# },
|
7815
|
-
# metric: {
|
7816
|
-
# expression: "Expression", # required
|
7817
|
-
# variables: [ # required
|
7818
|
-
# {
|
7819
|
-
# name: "VariableName", # required
|
7820
|
-
# value: { # required
|
7821
|
-
# property_id: "Macro", # required
|
7822
|
-
# hierarchy_id: "Macro",
|
7823
|
-
# },
|
7824
|
-
# },
|
7825
|
-
# ],
|
7826
|
-
# window: { # required
|
7827
|
-
# tumbling: {
|
7828
|
-
# interval: "Interval", # required
|
7829
|
-
# offset: "Offset",
|
7830
|
-
# },
|
7831
|
-
# },
|
7832
|
-
# processing_config: {
|
7833
|
-
# compute_location: "EDGE", # required, accepts EDGE, CLOUD
|
7834
|
-
# },
|
7835
|
-
# },
|
7836
|
-
# },
|
7837
|
-
# },
|
7838
|
-
# ],
|
7839
|
-
# asset_model_hierarchies: [
|
7840
|
-
# {
|
7841
|
-
# id: "ID",
|
7842
|
-
# name: "Name", # required
|
7843
|
-
# child_asset_model_id: "ID", # required
|
7844
|
-
# },
|
7845
|
-
# ],
|
7846
|
-
# asset_model_composite_models: [
|
7847
|
-
# {
|
7848
|
-
# name: "Name", # required
|
7849
|
-
# description: "Description",
|
7850
|
-
# type: "Name", # required
|
7851
|
-
# properties: [
|
7852
|
-
# {
|
7853
|
-
# id: "ID",
|
7854
|
-
# name: "Name", # required
|
7855
|
-
# data_type: "STRING", # required, accepts STRING, INTEGER, DOUBLE, BOOLEAN, STRUCT
|
7856
|
-
# data_type_spec: "Name",
|
7857
|
-
# unit: "PropertyUnit",
|
7858
|
-
# type: { # required
|
7859
|
-
# attribute: {
|
7860
|
-
# default_value: "DefaultValue",
|
7861
|
-
# },
|
7862
|
-
# measurement: {
|
7863
|
-
# processing_config: {
|
7864
|
-
# forwarding_config: { # required
|
7865
|
-
# state: "DISABLED", # required, accepts DISABLED, ENABLED
|
7866
|
-
# },
|
7867
|
-
# },
|
7868
|
-
# },
|
7869
|
-
# transform: {
|
7870
|
-
# expression: "Expression", # required
|
7871
|
-
# variables: [ # required
|
7872
|
-
# {
|
7873
|
-
# name: "VariableName", # required
|
7874
|
-
# value: { # required
|
7875
|
-
# property_id: "Macro", # required
|
7876
|
-
# hierarchy_id: "Macro",
|
7877
|
-
# },
|
7878
|
-
# },
|
7879
|
-
# ],
|
7880
|
-
# processing_config: {
|
7881
|
-
# compute_location: "EDGE", # required, accepts EDGE, CLOUD
|
7882
|
-
# forwarding_config: {
|
7883
|
-
# state: "DISABLED", # required, accepts DISABLED, ENABLED
|
7884
|
-
# },
|
7885
|
-
# },
|
7886
|
-
# },
|
7887
|
-
# metric: {
|
7888
|
-
# expression: "Expression", # required
|
7889
|
-
# variables: [ # required
|
7890
|
-
# {
|
7891
|
-
# name: "VariableName", # required
|
7892
|
-
# value: { # required
|
7893
|
-
# property_id: "Macro", # required
|
7894
|
-
# hierarchy_id: "Macro",
|
7895
|
-
# },
|
7896
|
-
# },
|
7897
|
-
# ],
|
7898
|
-
# window: { # required
|
7899
|
-
# tumbling: {
|
7900
|
-
# interval: "Interval", # required
|
7901
|
-
# offset: "Offset",
|
7902
|
-
# },
|
7903
|
-
# },
|
7904
|
-
# processing_config: {
|
7905
|
-
# compute_location: "EDGE", # required, accepts EDGE, CLOUD
|
7906
|
-
# },
|
7907
|
-
# },
|
7908
|
-
# },
|
7909
|
-
# },
|
7910
|
-
# ],
|
7911
|
-
# },
|
7912
|
-
# ],
|
7913
|
-
# client_token: "ClientToken",
|
7914
|
-
# }
|
7915
|
-
#
|
7916
6409
|
# @!attribute [rw] asset_model_id
|
7917
6410
|
# The ID of the asset model to update.
|
7918
6411
|
# @return [String]
|
@@ -7994,18 +6487,6 @@ module Aws::IoTSiteWise
|
|
7994
6487
|
include Aws::Structure
|
7995
6488
|
end
|
7996
6489
|
|
7997
|
-
# @note When making an API call, you may pass UpdateAssetPropertyRequest
|
7998
|
-
# data as a hash:
|
7999
|
-
#
|
8000
|
-
# {
|
8001
|
-
# asset_id: "ID", # required
|
8002
|
-
# property_id: "ID", # required
|
8003
|
-
# property_alias: "PropertyAlias",
|
8004
|
-
# property_notification_state: "ENABLED", # accepts ENABLED, DISABLED
|
8005
|
-
# client_token: "ClientToken",
|
8006
|
-
# property_unit: "PropertyUnit",
|
8007
|
-
# }
|
8008
|
-
#
|
8009
6490
|
# @!attribute [rw] asset_id
|
8010
6491
|
# The ID of the asset to be updated.
|
8011
6492
|
# @return [String]
|
@@ -8069,16 +6550,6 @@ module Aws::IoTSiteWise
|
|
8069
6550
|
include Aws::Structure
|
8070
6551
|
end
|
8071
6552
|
|
8072
|
-
# @note When making an API call, you may pass UpdateAssetRequest
|
8073
|
-
# data as a hash:
|
8074
|
-
#
|
8075
|
-
# {
|
8076
|
-
# asset_id: "ID", # required
|
8077
|
-
# asset_name: "Name", # required
|
8078
|
-
# client_token: "ClientToken",
|
8079
|
-
# asset_description: "Description",
|
8080
|
-
# }
|
8081
|
-
#
|
8082
6553
|
# @!attribute [rw] asset_id
|
8083
6554
|
# The ID of the asset to update.
|
8084
6555
|
# @return [String]
|
@@ -8120,17 +6591,6 @@ module Aws::IoTSiteWise
|
|
8120
6591
|
include Aws::Structure
|
8121
6592
|
end
|
8122
6593
|
|
8123
|
-
# @note When making an API call, you may pass UpdateDashboardRequest
|
8124
|
-
# data as a hash:
|
8125
|
-
#
|
8126
|
-
# {
|
8127
|
-
# dashboard_id: "ID", # required
|
8128
|
-
# dashboard_name: "Name", # required
|
8129
|
-
# dashboard_description: "Description",
|
8130
|
-
# dashboard_definition: "DashboardDefinition", # required
|
8131
|
-
# client_token: "ClientToken",
|
8132
|
-
# }
|
8133
|
-
#
|
8134
6594
|
# @!attribute [rw] dashboard_id
|
8135
6595
|
# The ID of the dashboard to update.
|
8136
6596
|
# @return [String]
|
@@ -8174,15 +6634,6 @@ module Aws::IoTSiteWise
|
|
8174
6634
|
|
8175
6635
|
class UpdateDashboardResponse < Aws::EmptyStructure; end
|
8176
6636
|
|
8177
|
-
# @note When making an API call, you may pass UpdateGatewayCapabilityConfigurationRequest
|
8178
|
-
# data as a hash:
|
8179
|
-
#
|
8180
|
-
# {
|
8181
|
-
# gateway_id: "ID", # required
|
8182
|
-
# capability_namespace: "CapabilityNamespace", # required
|
8183
|
-
# capability_configuration: "CapabilityConfiguration", # required
|
8184
|
-
# }
|
8185
|
-
#
|
8186
6637
|
# @!attribute [rw] gateway_id
|
8187
6638
|
# The ID of the gateway to be updated.
|
8188
6639
|
# @return [String]
|
@@ -8240,14 +6691,6 @@ module Aws::IoTSiteWise
|
|
8240
6691
|
include Aws::Structure
|
8241
6692
|
end
|
8242
6693
|
|
8243
|
-
# @note When making an API call, you may pass UpdateGatewayRequest
|
8244
|
-
# data as a hash:
|
8245
|
-
#
|
8246
|
-
# {
|
8247
|
-
# gateway_id: "ID", # required
|
8248
|
-
# gateway_name: "Name", # required
|
8249
|
-
# }
|
8250
|
-
#
|
8251
6694
|
# @!attribute [rw] gateway_id
|
8252
6695
|
# The ID of the gateway to update.
|
8253
6696
|
# @return [String]
|
@@ -8263,30 +6706,6 @@ module Aws::IoTSiteWise
|
|
8263
6706
|
include Aws::Structure
|
8264
6707
|
end
|
8265
6708
|
|
8266
|
-
# @note When making an API call, you may pass UpdatePortalRequest
|
8267
|
-
# data as a hash:
|
8268
|
-
#
|
8269
|
-
# {
|
8270
|
-
# portal_id: "ID", # required
|
8271
|
-
# portal_name: "Name", # required
|
8272
|
-
# portal_description: "Description",
|
8273
|
-
# portal_contact_email: "Email", # required
|
8274
|
-
# portal_logo_image: {
|
8275
|
-
# id: "ID",
|
8276
|
-
# file: {
|
8277
|
-
# data: "data", # required
|
8278
|
-
# type: "PNG", # required, accepts PNG
|
8279
|
-
# },
|
8280
|
-
# },
|
8281
|
-
# role_arn: "ARN", # required
|
8282
|
-
# client_token: "ClientToken",
|
8283
|
-
# notification_sender_email: "Email",
|
8284
|
-
# alarms: {
|
8285
|
-
# alarm_role_arn: "ARN", # required
|
8286
|
-
# notification_lambda_arn: "ARN",
|
8287
|
-
# },
|
8288
|
-
# }
|
8289
|
-
#
|
8290
6709
|
# @!attribute [rw] portal_id
|
8291
6710
|
# The ID of the portal to update.
|
8292
6711
|
# @return [String]
|
@@ -8374,16 +6793,6 @@ module Aws::IoTSiteWise
|
|
8374
6793
|
include Aws::Structure
|
8375
6794
|
end
|
8376
6795
|
|
8377
|
-
# @note When making an API call, you may pass UpdateProjectRequest
|
8378
|
-
# data as a hash:
|
8379
|
-
#
|
8380
|
-
# {
|
8381
|
-
# project_id: "ID", # required
|
8382
|
-
# project_name: "Name", # required
|
8383
|
-
# project_description: "Description",
|
8384
|
-
# client_token: "ClientToken",
|
8385
|
-
# }
|
8386
|
-
#
|
8387
6796
|
# @!attribute [rw] project_id
|
8388
6797
|
# The ID of the project to update.
|
8389
6798
|
# @return [String]
|
@@ -8418,15 +6827,8 @@ module Aws::IoTSiteWise
|
|
8418
6827
|
|
8419
6828
|
# Contains information for a user identity in an access policy.
|
8420
6829
|
#
|
8421
|
-
# @note When making an API call, you may pass UserIdentity
|
8422
|
-
# data as a hash:
|
8423
|
-
#
|
8424
|
-
# {
|
8425
|
-
# id: "IdentityId", # required
|
8426
|
-
# }
|
8427
|
-
#
|
8428
6830
|
# @!attribute [rw] id
|
8429
|
-
# The
|
6831
|
+
# The IAM Identity Center ID of the user.
|
8430
6832
|
# @return [String]
|
8431
6833
|
#
|
8432
6834
|
class UserIdentity < Struct.new(
|
@@ -8437,14 +6839,6 @@ module Aws::IoTSiteWise
|
|
8437
6839
|
|
8438
6840
|
# Identifies a property value used in an expression.
|
8439
6841
|
#
|
8440
|
-
# @note When making an API call, you may pass VariableValue
|
8441
|
-
# data as a hash:
|
8442
|
-
#
|
8443
|
-
# {
|
8444
|
-
# property_id: "Macro", # required
|
8445
|
-
# hierarchy_id: "Macro",
|
8446
|
-
# }
|
8447
|
-
#
|
8448
6842
|
# @!attribute [rw] property_id
|
8449
6843
|
# The ID of the property to use as the variable. You can use the
|
8450
6844
|
# property `name` if it's from the same asset model.
|
@@ -8474,16 +6868,6 @@ module Aws::IoTSiteWise
|
|
8474
6868
|
|
8475
6869
|
# Contains an asset property value (of a single type only).
|
8476
6870
|
#
|
8477
|
-
# @note When making an API call, you may pass Variant
|
8478
|
-
# data as a hash:
|
8479
|
-
#
|
8480
|
-
# {
|
8481
|
-
# string_value: "PropertyValueStringValue",
|
8482
|
-
# integer_value: 1,
|
8483
|
-
# double_value: 1.0,
|
8484
|
-
# boolean_value: false,
|
8485
|
-
# }
|
8486
|
-
#
|
8487
6871
|
# @!attribute [rw] string_value
|
8488
6872
|
# Asset property data of type string (sequence of characters).
|
8489
6873
|
# @return [String]
|