aws-sdk-iotsitewise 1.68.0 → 1.69.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-iotsitewise/client.rb +274 -97
- data/lib/aws-sdk-iotsitewise/client_api.rb +59 -20
- data/lib/aws-sdk-iotsitewise/errors.rb +26 -0
- data/lib/aws-sdk-iotsitewise/types.rb +470 -224
- data/lib/aws-sdk-iotsitewise.rb +1 -1
- data/sig/client.rbs +67 -43
- data/sig/errors.rbs +5 -0
- data/sig/types.rbs +50 -20
- data/sig/waiters.rbs +4 -2
- metadata +2 -2
@@ -1154,6 +1154,33 @@ module Aws::IoTSiteWise
|
|
1154
1154
|
# @option params [required, String] :asset_model_name
|
1155
1155
|
# A unique name for the asset model.
|
1156
1156
|
#
|
1157
|
+
# @option params [String] :asset_model_type
|
1158
|
+
# The type of asset model.
|
1159
|
+
#
|
1160
|
+
# * **ASSET\_MODEL** – (default) An asset model that you can use to
|
1161
|
+
# create assets. Can't be included as a component in another asset
|
1162
|
+
# model.
|
1163
|
+
#
|
1164
|
+
# * **COMPONENT\_MODEL** – A reusable component that you can include in
|
1165
|
+
# the composite models of other asset models. You can't create assets
|
1166
|
+
# directly from this type of asset model.
|
1167
|
+
#
|
1168
|
+
# @option params [String] :asset_model_id
|
1169
|
+
# The ID to assign to the asset model, if desired. IoT SiteWise
|
1170
|
+
# automatically generates a unique ID for you, so this parameter is
|
1171
|
+
# never required. However, if you prefer to supply your own ID instead,
|
1172
|
+
# you can specify it here in UUID format. If you specify your own ID, it
|
1173
|
+
# must be globally unique.
|
1174
|
+
#
|
1175
|
+
# @option params [String] :asset_model_external_id
|
1176
|
+
# An external ID to assign to the asset model. The external ID must be
|
1177
|
+
# unique within your Amazon Web Services account. For more information,
|
1178
|
+
# see [Using external IDs][1] in the *IoT SiteWise User Guide*.
|
1179
|
+
#
|
1180
|
+
#
|
1181
|
+
#
|
1182
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
|
1183
|
+
#
|
1157
1184
|
# @option params [String] :asset_model_description
|
1158
1185
|
# A description for the asset model.
|
1159
1186
|
#
|
@@ -1220,33 +1247,6 @@ module Aws::IoTSiteWise
|
|
1220
1247
|
#
|
1221
1248
|
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html
|
1222
1249
|
#
|
1223
|
-
# @option params [String] :asset_model_id
|
1224
|
-
# The ID to assign to the asset model, if desired. IoT SiteWise
|
1225
|
-
# automatically generates a unique ID for you, so this parameter is
|
1226
|
-
# never required. However, if you prefer to supply your own ID instead,
|
1227
|
-
# you can specify it here in UUID format. If you specify your own ID, it
|
1228
|
-
# must be globally unique.
|
1229
|
-
#
|
1230
|
-
# @option params [String] :asset_model_external_id
|
1231
|
-
# An external ID to assign to the asset model. The external ID must be
|
1232
|
-
# unique within your Amazon Web Services account. For more information,
|
1233
|
-
# see [Using external IDs][1] in the *IoT SiteWise User Guide*.
|
1234
|
-
#
|
1235
|
-
#
|
1236
|
-
#
|
1237
|
-
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
|
1238
|
-
#
|
1239
|
-
# @option params [String] :asset_model_type
|
1240
|
-
# The type of asset model.
|
1241
|
-
#
|
1242
|
-
# * **ASSET\_MODEL** – (default) An asset model that you can use to
|
1243
|
-
# create assets. Can't be included as a component in another asset
|
1244
|
-
# model.
|
1245
|
-
#
|
1246
|
-
# * **COMPONENT\_MODEL** – A reusable component that you can include in
|
1247
|
-
# the composite models of other asset models. You can't create assets
|
1248
|
-
# directly from this type of asset model.
|
1249
|
-
#
|
1250
1250
|
# @return [Types::CreateAssetModelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1251
1251
|
#
|
1252
1252
|
# * {Types::CreateAssetModelResponse#asset_model_id #asset_model_id} => String
|
@@ -1257,9 +1257,14 @@ module Aws::IoTSiteWise
|
|
1257
1257
|
#
|
1258
1258
|
# resp = client.create_asset_model({
|
1259
1259
|
# asset_model_name: "Name", # required
|
1260
|
+
# asset_model_type: "ASSET_MODEL", # accepts ASSET_MODEL, COMPONENT_MODEL
|
1261
|
+
# asset_model_id: "ID",
|
1262
|
+
# asset_model_external_id: "ExternalId",
|
1260
1263
|
# asset_model_description: "Description",
|
1261
1264
|
# asset_model_properties: [
|
1262
1265
|
# {
|
1266
|
+
# id: "ID",
|
1267
|
+
# external_id: "ExternalId",
|
1263
1268
|
# name: "Name", # required
|
1264
1269
|
# data_type: "STRING", # required, accepts STRING, INTEGER, DOUBLE, BOOLEAN, STRUCT
|
1265
1270
|
# data_type_spec: "Name",
|
@@ -1327,25 +1332,27 @@ module Aws::IoTSiteWise
|
|
1327
1332
|
# },
|
1328
1333
|
# },
|
1329
1334
|
# },
|
1330
|
-
# id: "ID",
|
1331
|
-
# external_id: "ExternalId",
|
1332
1335
|
# },
|
1333
1336
|
# ],
|
1334
1337
|
# asset_model_hierarchies: [
|
1335
1338
|
# {
|
1336
|
-
# name: "Name", # required
|
1337
|
-
# child_asset_model_id: "CustomID", # required
|
1338
1339
|
# id: "ID",
|
1339
1340
|
# external_id: "ExternalId",
|
1341
|
+
# name: "Name", # required
|
1342
|
+
# child_asset_model_id: "CustomID", # required
|
1340
1343
|
# },
|
1341
1344
|
# ],
|
1342
1345
|
# asset_model_composite_models: [
|
1343
1346
|
# {
|
1347
|
+
# id: "ID",
|
1348
|
+
# external_id: "ExternalId",
|
1344
1349
|
# name: "Name", # required
|
1345
1350
|
# description: "Description",
|
1346
1351
|
# type: "Name", # required
|
1347
1352
|
# properties: [
|
1348
1353
|
# {
|
1354
|
+
# id: "ID",
|
1355
|
+
# external_id: "ExternalId",
|
1349
1356
|
# name: "Name", # required
|
1350
1357
|
# data_type: "STRING", # required, accepts STRING, INTEGER, DOUBLE, BOOLEAN, STRUCT
|
1351
1358
|
# data_type_spec: "Name",
|
@@ -1413,21 +1420,14 @@ module Aws::IoTSiteWise
|
|
1413
1420
|
# },
|
1414
1421
|
# },
|
1415
1422
|
# },
|
1416
|
-
# id: "ID",
|
1417
|
-
# external_id: "ExternalId",
|
1418
1423
|
# },
|
1419
1424
|
# ],
|
1420
|
-
# id: "ID",
|
1421
|
-
# external_id: "ExternalId",
|
1422
1425
|
# },
|
1423
1426
|
# ],
|
1424
1427
|
# client_token: "ClientToken",
|
1425
1428
|
# tags: {
|
1426
1429
|
# "TagKey" => "TagValue",
|
1427
1430
|
# },
|
1428
|
-
# asset_model_id: "ID",
|
1429
|
-
# asset_model_external_id: "ExternalId",
|
1430
|
-
# asset_model_type: "ASSET_MODEL", # accepts ASSET_MODEL, COMPONENT_MODEL
|
1431
1431
|
# })
|
1432
1432
|
#
|
1433
1433
|
# @example Response structure
|
@@ -1481,9 +1481,6 @@ module Aws::IoTSiteWise
|
|
1481
1481
|
# @option params [required, String] :asset_model_id
|
1482
1482
|
# The ID of the asset model this composite model is a part of.
|
1483
1483
|
#
|
1484
|
-
# @option params [String] :parent_asset_model_composite_model_id
|
1485
|
-
# The ID of the parent composite model in this asset model relationship.
|
1486
|
-
#
|
1487
1484
|
# @option params [String] :asset_model_composite_model_external_id
|
1488
1485
|
# An external ID to assign to the composite model.
|
1489
1486
|
#
|
@@ -1492,6 +1489,9 @@ module Aws::IoTSiteWise
|
|
1492
1489
|
# `UpdateAssetModelCompositeModel` and specifying the derived ID of the
|
1493
1490
|
# model or property from the created model it's a part of.
|
1494
1491
|
#
|
1492
|
+
# @option params [String] :parent_asset_model_composite_model_id
|
1493
|
+
# The ID of the parent composite model in this asset model relationship.
|
1494
|
+
#
|
1495
1495
|
# @option params [String] :asset_model_composite_model_id
|
1496
1496
|
# The ID of the composite model. IoT SiteWise automatically generates a
|
1497
1497
|
# unique ID for you, so this parameter is never required. However, if
|
@@ -1533,6 +1533,27 @@ module Aws::IoTSiteWise
|
|
1533
1533
|
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/custom-composite-models.html#inline-composite-models
|
1534
1534
|
# [2]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html
|
1535
1535
|
#
|
1536
|
+
# @option params [String] :if_match
|
1537
|
+
# The expected current entity tag (ETag) for the asset model’s latest or
|
1538
|
+
# active version (specified using `matchForVersionType`). The create
|
1539
|
+
# request is rejected if the tag does not match the latest or active
|
1540
|
+
# version's current entity tag. See [Optimistic locking for asset model
|
1541
|
+
# writes][1] in the *IoT SiteWise User Guide*.
|
1542
|
+
#
|
1543
|
+
#
|
1544
|
+
#
|
1545
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/opt-locking-for-model.html
|
1546
|
+
#
|
1547
|
+
# @option params [String] :if_none_match
|
1548
|
+
# Accepts ***** to reject the create request if an active version
|
1549
|
+
# (specified using `matchForVersionType` as `ACTIVE`) already exists for
|
1550
|
+
# the asset model.
|
1551
|
+
#
|
1552
|
+
# @option params [String] :match_for_version_type
|
1553
|
+
# Specifies the asset model version type (`LATEST` or `ACTIVE`) used in
|
1554
|
+
# conjunction with `If-Match` or `If-None-Match` headers to determine
|
1555
|
+
# the target ETag for the create operation.
|
1556
|
+
#
|
1536
1557
|
# @return [Types::CreateAssetModelCompositeModelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1537
1558
|
#
|
1538
1559
|
# * {Types::CreateAssetModelCompositeModelResponse#asset_model_composite_model_id #asset_model_composite_model_id} => String
|
@@ -1543,8 +1564,8 @@ module Aws::IoTSiteWise
|
|
1543
1564
|
#
|
1544
1565
|
# resp = client.create_asset_model_composite_model({
|
1545
1566
|
# asset_model_id: "CustomID", # required
|
1546
|
-
# parent_asset_model_composite_model_id: "CustomID",
|
1547
1567
|
# asset_model_composite_model_external_id: "ExternalId",
|
1568
|
+
# parent_asset_model_composite_model_id: "CustomID",
|
1548
1569
|
# asset_model_composite_model_id: "ID",
|
1549
1570
|
# asset_model_composite_model_description: "Description",
|
1550
1571
|
# asset_model_composite_model_name: "Name", # required
|
@@ -1553,6 +1574,8 @@ module Aws::IoTSiteWise
|
|
1553
1574
|
# composed_asset_model_id: "CustomID",
|
1554
1575
|
# asset_model_composite_model_properties: [
|
1555
1576
|
# {
|
1577
|
+
# id: "ID",
|
1578
|
+
# external_id: "ExternalId",
|
1556
1579
|
# name: "Name", # required
|
1557
1580
|
# data_type: "STRING", # required, accepts STRING, INTEGER, DOUBLE, BOOLEAN, STRUCT
|
1558
1581
|
# data_type_spec: "Name",
|
@@ -1620,10 +1643,11 @@ module Aws::IoTSiteWise
|
|
1620
1643
|
# },
|
1621
1644
|
# },
|
1622
1645
|
# },
|
1623
|
-
# id: "ID",
|
1624
|
-
# external_id: "ExternalId",
|
1625
1646
|
# },
|
1626
1647
|
# ],
|
1648
|
+
# if_match: "ETag",
|
1649
|
+
# if_none_match: "SelectAll",
|
1650
|
+
# match_for_version_type: "LATEST", # accepts LATEST, ACTIVE
|
1627
1651
|
# })
|
1628
1652
|
#
|
1629
1653
|
# @example Response structure
|
@@ -2198,6 +2222,27 @@ module Aws::IoTSiteWise
|
|
2198
2222
|
# **A suitable default value is auto-generated.** You should normally
|
2199
2223
|
# not need to pass this option.**
|
2200
2224
|
#
|
2225
|
+
# @option params [String] :if_match
|
2226
|
+
# The expected current entity tag (ETag) for the asset model’s latest or
|
2227
|
+
# active version (specified using `matchForVersionType`). The delete
|
2228
|
+
# request is rejected if the tag does not match the latest or active
|
2229
|
+
# version's current entity tag. See [Optimistic locking for asset model
|
2230
|
+
# writes][1] in the *IoT SiteWise User Guide*.
|
2231
|
+
#
|
2232
|
+
#
|
2233
|
+
#
|
2234
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/opt-locking-for-model.html
|
2235
|
+
#
|
2236
|
+
# @option params [String] :if_none_match
|
2237
|
+
# Accepts ***** to reject the delete request if an active version
|
2238
|
+
# (specified using `matchForVersionType` as `ACTIVE`) already exists for
|
2239
|
+
# the asset model.
|
2240
|
+
#
|
2241
|
+
# @option params [String] :match_for_version_type
|
2242
|
+
# Specifies the asset model version type (`LATEST` or `ACTIVE`) used in
|
2243
|
+
# conjunction with `If-Match` or `If-None-Match` headers to determine
|
2244
|
+
# the target ETag for the delete operation.
|
2245
|
+
#
|
2201
2246
|
# @return [Types::DeleteAssetModelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2202
2247
|
#
|
2203
2248
|
# * {Types::DeleteAssetModelResponse#asset_model_status #asset_model_status} => Types::AssetModelStatus
|
@@ -2207,6 +2252,9 @@ module Aws::IoTSiteWise
|
|
2207
2252
|
# resp = client.delete_asset_model({
|
2208
2253
|
# asset_model_id: "CustomID", # required
|
2209
2254
|
# client_token: "ClientToken",
|
2255
|
+
# if_match: "ETag",
|
2256
|
+
# if_none_match: "SelectAll",
|
2257
|
+
# match_for_version_type: "LATEST", # accepts LATEST, ACTIVE
|
2210
2258
|
# })
|
2211
2259
|
#
|
2212
2260
|
# @example Response structure
|
@@ -2250,6 +2298,27 @@ module Aws::IoTSiteWise
|
|
2250
2298
|
# **A suitable default value is auto-generated.** You should normally
|
2251
2299
|
# not need to pass this option.**
|
2252
2300
|
#
|
2301
|
+
# @option params [String] :if_match
|
2302
|
+
# The expected current entity tag (ETag) for the asset model’s latest or
|
2303
|
+
# active version (specified using `matchForVersionType`). The delete
|
2304
|
+
# request is rejected if the tag does not match the latest or active
|
2305
|
+
# version's current entity tag. See [Optimistic locking for asset model
|
2306
|
+
# writes][1] in the *IoT SiteWise User Guide*.
|
2307
|
+
#
|
2308
|
+
#
|
2309
|
+
#
|
2310
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/opt-locking-for-model.html
|
2311
|
+
#
|
2312
|
+
# @option params [String] :if_none_match
|
2313
|
+
# Accepts ***** to reject the delete request if an active version
|
2314
|
+
# (specified using `matchForVersionType` as `ACTIVE`) already exists for
|
2315
|
+
# the asset model.
|
2316
|
+
#
|
2317
|
+
# @option params [String] :match_for_version_type
|
2318
|
+
# Specifies the asset model version type (`LATEST` or `ACTIVE`) used in
|
2319
|
+
# conjunction with `If-Match` or `If-None-Match` headers to determine
|
2320
|
+
# the target ETag for the delete operation.
|
2321
|
+
#
|
2253
2322
|
# @return [Types::DeleteAssetModelCompositeModelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2254
2323
|
#
|
2255
2324
|
# * {Types::DeleteAssetModelCompositeModelResponse#asset_model_status #asset_model_status} => Types::AssetModelStatus
|
@@ -2260,6 +2329,9 @@ module Aws::IoTSiteWise
|
|
2260
2329
|
# asset_model_id: "CustomID", # required
|
2261
2330
|
# asset_model_composite_model_id: "CustomID", # required
|
2262
2331
|
# client_token: "ClientToken",
|
2332
|
+
# if_match: "ETag",
|
2333
|
+
# if_none_match: "SelectAll",
|
2334
|
+
# match_for_version_type: "LATEST", # accepts LATEST, ACTIVE
|
2263
2335
|
# })
|
2264
2336
|
#
|
2265
2337
|
# @example Response structure
|
@@ -2760,37 +2832,53 @@ module Aws::IoTSiteWise
|
|
2760
2832
|
# @option params [Boolean] :exclude_properties
|
2761
2833
|
# Whether or not to exclude asset model properties from the response.
|
2762
2834
|
#
|
2835
|
+
# @option params [String] :asset_model_version
|
2836
|
+
# The version alias that specifies the latest or active version of the
|
2837
|
+
# asset model. The details are returned in the response. The default
|
2838
|
+
# value is `LATEST`. See [ Asset model versions][1] in the *IoT SiteWise
|
2839
|
+
# User Guide*.
|
2840
|
+
#
|
2841
|
+
#
|
2842
|
+
#
|
2843
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/model-active-version.html
|
2844
|
+
#
|
2763
2845
|
# @return [Types::DescribeAssetModelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2764
2846
|
#
|
2765
2847
|
# * {Types::DescribeAssetModelResponse#asset_model_id #asset_model_id} => String
|
2848
|
+
# * {Types::DescribeAssetModelResponse#asset_model_external_id #asset_model_external_id} => String
|
2766
2849
|
# * {Types::DescribeAssetModelResponse#asset_model_arn #asset_model_arn} => String
|
2767
2850
|
# * {Types::DescribeAssetModelResponse#asset_model_name #asset_model_name} => String
|
2851
|
+
# * {Types::DescribeAssetModelResponse#asset_model_type #asset_model_type} => String
|
2768
2852
|
# * {Types::DescribeAssetModelResponse#asset_model_description #asset_model_description} => String
|
2769
2853
|
# * {Types::DescribeAssetModelResponse#asset_model_properties #asset_model_properties} => Array<Types::AssetModelProperty>
|
2770
2854
|
# * {Types::DescribeAssetModelResponse#asset_model_hierarchies #asset_model_hierarchies} => Array<Types::AssetModelHierarchy>
|
2771
2855
|
# * {Types::DescribeAssetModelResponse#asset_model_composite_models #asset_model_composite_models} => Array<Types::AssetModelCompositeModel>
|
2856
|
+
# * {Types::DescribeAssetModelResponse#asset_model_composite_model_summaries #asset_model_composite_model_summaries} => Array<Types::AssetModelCompositeModelSummary>
|
2772
2857
|
# * {Types::DescribeAssetModelResponse#asset_model_creation_date #asset_model_creation_date} => Time
|
2773
2858
|
# * {Types::DescribeAssetModelResponse#asset_model_last_update_date #asset_model_last_update_date} => Time
|
2774
2859
|
# * {Types::DescribeAssetModelResponse#asset_model_status #asset_model_status} => Types::AssetModelStatus
|
2775
|
-
# * {Types::DescribeAssetModelResponse#
|
2776
|
-
# * {Types::DescribeAssetModelResponse#
|
2777
|
-
# * {Types::DescribeAssetModelResponse#asset_model_external_id #asset_model_external_id} => String
|
2860
|
+
# * {Types::DescribeAssetModelResponse#asset_model_version #asset_model_version} => String
|
2861
|
+
# * {Types::DescribeAssetModelResponse#e_tag #e_tag} => String
|
2778
2862
|
#
|
2779
2863
|
# @example Request syntax with placeholder values
|
2780
2864
|
#
|
2781
2865
|
# resp = client.describe_asset_model({
|
2782
2866
|
# asset_model_id: "CustomID", # required
|
2783
2867
|
# exclude_properties: false,
|
2868
|
+
# asset_model_version: "AssetModelVersionFilter",
|
2784
2869
|
# })
|
2785
2870
|
#
|
2786
2871
|
# @example Response structure
|
2787
2872
|
#
|
2788
2873
|
# resp.asset_model_id #=> String
|
2874
|
+
# resp.asset_model_external_id #=> String
|
2789
2875
|
# resp.asset_model_arn #=> String
|
2790
2876
|
# resp.asset_model_name #=> String
|
2877
|
+
# resp.asset_model_type #=> String, one of "ASSET_MODEL", "COMPONENT_MODEL"
|
2791
2878
|
# resp.asset_model_description #=> String
|
2792
2879
|
# resp.asset_model_properties #=> Array
|
2793
2880
|
# resp.asset_model_properties[0].id #=> String
|
2881
|
+
# resp.asset_model_properties[0].external_id #=> String
|
2794
2882
|
# resp.asset_model_properties[0].name #=> String
|
2795
2883
|
# resp.asset_model_properties[0].data_type #=> String, one of "STRING", "INTEGER", "DOUBLE", "BOOLEAN", "STRUCT"
|
2796
2884
|
# resp.asset_model_properties[0].data_type_spec #=> String
|
@@ -2821,18 +2909,18 @@ module Aws::IoTSiteWise
|
|
2821
2909
|
# resp.asset_model_properties[0].path #=> Array
|
2822
2910
|
# resp.asset_model_properties[0].path[0].id #=> String
|
2823
2911
|
# resp.asset_model_properties[0].path[0].name #=> String
|
2824
|
-
# resp.asset_model_properties[0].external_id #=> String
|
2825
2912
|
# resp.asset_model_hierarchies #=> Array
|
2826
2913
|
# resp.asset_model_hierarchies[0].id #=> String
|
2914
|
+
# resp.asset_model_hierarchies[0].external_id #=> String
|
2827
2915
|
# resp.asset_model_hierarchies[0].name #=> String
|
2828
2916
|
# resp.asset_model_hierarchies[0].child_asset_model_id #=> String
|
2829
|
-
# resp.asset_model_hierarchies[0].external_id #=> String
|
2830
2917
|
# resp.asset_model_composite_models #=> Array
|
2831
2918
|
# resp.asset_model_composite_models[0].name #=> String
|
2832
2919
|
# resp.asset_model_composite_models[0].description #=> String
|
2833
2920
|
# resp.asset_model_composite_models[0].type #=> String
|
2834
2921
|
# resp.asset_model_composite_models[0].properties #=> Array
|
2835
2922
|
# resp.asset_model_composite_models[0].properties[0].id #=> String
|
2923
|
+
# resp.asset_model_composite_models[0].properties[0].external_id #=> String
|
2836
2924
|
# resp.asset_model_composite_models[0].properties[0].name #=> String
|
2837
2925
|
# resp.asset_model_composite_models[0].properties[0].data_type #=> String, one of "STRING", "INTEGER", "DOUBLE", "BOOLEAN", "STRUCT"
|
2838
2926
|
# resp.asset_model_composite_models[0].properties[0].data_type_spec #=> String
|
@@ -2863,18 +2951,8 @@ module Aws::IoTSiteWise
|
|
2863
2951
|
# resp.asset_model_composite_models[0].properties[0].path #=> Array
|
2864
2952
|
# resp.asset_model_composite_models[0].properties[0].path[0].id #=> String
|
2865
2953
|
# resp.asset_model_composite_models[0].properties[0].path[0].name #=> String
|
2866
|
-
# resp.asset_model_composite_models[0].properties[0].external_id #=> String
|
2867
2954
|
# resp.asset_model_composite_models[0].id #=> String
|
2868
2955
|
# resp.asset_model_composite_models[0].external_id #=> String
|
2869
|
-
# resp.asset_model_creation_date #=> Time
|
2870
|
-
# resp.asset_model_last_update_date #=> Time
|
2871
|
-
# resp.asset_model_status.state #=> String, one of "CREATING", "ACTIVE", "UPDATING", "PROPAGATING", "DELETING", "FAILED"
|
2872
|
-
# resp.asset_model_status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
|
2873
|
-
# resp.asset_model_status.error.message #=> String
|
2874
|
-
# resp.asset_model_status.error.details #=> Array
|
2875
|
-
# resp.asset_model_status.error.details[0].code #=> String, one of "INCOMPATIBLE_COMPUTE_LOCATION", "INCOMPATIBLE_FORWARDING_CONFIGURATION"
|
2876
|
-
# resp.asset_model_status.error.details[0].message #=> String
|
2877
|
-
# resp.asset_model_type #=> String, one of "ASSET_MODEL", "COMPONENT_MODEL"
|
2878
2956
|
# resp.asset_model_composite_model_summaries #=> Array
|
2879
2957
|
# resp.asset_model_composite_model_summaries[0].id #=> String
|
2880
2958
|
# resp.asset_model_composite_model_summaries[0].external_id #=> String
|
@@ -2884,7 +2962,16 @@ module Aws::IoTSiteWise
|
|
2884
2962
|
# resp.asset_model_composite_model_summaries[0].path #=> Array
|
2885
2963
|
# resp.asset_model_composite_model_summaries[0].path[0].id #=> String
|
2886
2964
|
# resp.asset_model_composite_model_summaries[0].path[0].name #=> String
|
2887
|
-
# resp.
|
2965
|
+
# resp.asset_model_creation_date #=> Time
|
2966
|
+
# resp.asset_model_last_update_date #=> Time
|
2967
|
+
# resp.asset_model_status.state #=> String, one of "CREATING", "ACTIVE", "UPDATING", "PROPAGATING", "DELETING", "FAILED"
|
2968
|
+
# resp.asset_model_status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
|
2969
|
+
# resp.asset_model_status.error.message #=> String
|
2970
|
+
# resp.asset_model_status.error.details #=> Array
|
2971
|
+
# resp.asset_model_status.error.details[0].code #=> String, one of "INCOMPATIBLE_COMPUTE_LOCATION", "INCOMPATIBLE_FORWARDING_CONFIGURATION"
|
2972
|
+
# resp.asset_model_status.error.details[0].message #=> String
|
2973
|
+
# resp.asset_model_version #=> String
|
2974
|
+
# resp.e_tag #=> String
|
2888
2975
|
#
|
2889
2976
|
#
|
2890
2977
|
# The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
|
@@ -2927,6 +3014,16 @@ module Aws::IoTSiteWise
|
|
2927
3014
|
#
|
2928
3015
|
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references
|
2929
3016
|
#
|
3017
|
+
# @option params [String] :asset_model_version
|
3018
|
+
# The version alias that specifies the latest or active version of the
|
3019
|
+
# asset model. The details are returned in the response. The default
|
3020
|
+
# value is `LATEST`. See [ Asset model versions][1] in the *IoT SiteWise
|
3021
|
+
# User Guide*.
|
3022
|
+
#
|
3023
|
+
#
|
3024
|
+
#
|
3025
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/model-active-version.html
|
3026
|
+
#
|
2930
3027
|
# @return [Types::DescribeAssetModelCompositeModelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2931
3028
|
#
|
2932
3029
|
# * {Types::DescribeAssetModelCompositeModelResponse#asset_model_id #asset_model_id} => String
|
@@ -2946,6 +3043,7 @@ module Aws::IoTSiteWise
|
|
2946
3043
|
# resp = client.describe_asset_model_composite_model({
|
2947
3044
|
# asset_model_id: "CustomID", # required
|
2948
3045
|
# asset_model_composite_model_id: "CustomID", # required
|
3046
|
+
# asset_model_version: "AssetModelVersionFilter",
|
2949
3047
|
# })
|
2950
3048
|
#
|
2951
3049
|
# @example Response structure
|
@@ -2961,6 +3059,7 @@ module Aws::IoTSiteWise
|
|
2961
3059
|
# resp.asset_model_composite_model_type #=> String
|
2962
3060
|
# resp.asset_model_composite_model_properties #=> Array
|
2963
3061
|
# resp.asset_model_composite_model_properties[0].id #=> String
|
3062
|
+
# resp.asset_model_composite_model_properties[0].external_id #=> String
|
2964
3063
|
# resp.asset_model_composite_model_properties[0].name #=> String
|
2965
3064
|
# resp.asset_model_composite_model_properties[0].data_type #=> String, one of "STRING", "INTEGER", "DOUBLE", "BOOLEAN", "STRUCT"
|
2966
3065
|
# resp.asset_model_composite_model_properties[0].data_type_spec #=> String
|
@@ -2991,7 +3090,6 @@ module Aws::IoTSiteWise
|
|
2991
3090
|
# resp.asset_model_composite_model_properties[0].path #=> Array
|
2992
3091
|
# resp.asset_model_composite_model_properties[0].path[0].id #=> String
|
2993
3092
|
# resp.asset_model_composite_model_properties[0].path[0].name #=> String
|
2994
|
-
# resp.asset_model_composite_model_properties[0].external_id #=> String
|
2995
3093
|
# resp.composition_details.composition_relationship #=> Array
|
2996
3094
|
# resp.composition_details.composition_relationship[0].id #=> String
|
2997
3095
|
# resp.asset_model_composite_model_summaries #=> Array
|
@@ -4403,6 +4501,16 @@ module Aws::IoTSiteWise
|
|
4403
4501
|
#
|
4404
4502
|
# Default: 50
|
4405
4503
|
#
|
4504
|
+
# @option params [String] :asset_model_version
|
4505
|
+
# The version alias that specifies the latest or active version of the
|
4506
|
+
# asset model. The details are returned in the response. The default
|
4507
|
+
# value is `LATEST`. See [ Asset model versions][1] in the *IoT SiteWise
|
4508
|
+
# User Guide*.
|
4509
|
+
#
|
4510
|
+
#
|
4511
|
+
#
|
4512
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/model-active-version.html
|
4513
|
+
#
|
4406
4514
|
# @return [Types::ListAssetModelCompositeModelsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4407
4515
|
#
|
4408
4516
|
# * {Types::ListAssetModelCompositeModelsResponse#asset_model_composite_model_summaries #asset_model_composite_model_summaries} => Array<Types::AssetModelCompositeModelSummary>
|
@@ -4416,6 +4524,7 @@ module Aws::IoTSiteWise
|
|
4416
4524
|
# asset_model_id: "CustomID", # required
|
4417
4525
|
# next_token: "NextToken",
|
4418
4526
|
# max_results: 1,
|
4527
|
+
# asset_model_version: "AssetModelVersionFilter",
|
4419
4528
|
# })
|
4420
4529
|
#
|
4421
4530
|
# @example Response structure
|
@@ -4471,6 +4580,16 @@ module Aws::IoTSiteWise
|
|
4471
4580
|
#
|
4472
4581
|
# Default: `BASE`
|
4473
4582
|
#
|
4583
|
+
# @option params [String] :asset_model_version
|
4584
|
+
# The version alias that specifies the latest or active version of the
|
4585
|
+
# asset model. The details are returned in the response. The default
|
4586
|
+
# value is `LATEST`. See [ Asset model versions][1] in the *IoT SiteWise
|
4587
|
+
# User Guide*.
|
4588
|
+
#
|
4589
|
+
#
|
4590
|
+
#
|
4591
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/model-active-version.html
|
4592
|
+
#
|
4474
4593
|
# @return [Types::ListAssetModelPropertiesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4475
4594
|
#
|
4476
4595
|
# * {Types::ListAssetModelPropertiesResponse#asset_model_property_summaries #asset_model_property_summaries} => Array<Types::AssetModelPropertySummary>
|
@@ -4485,12 +4604,14 @@ module Aws::IoTSiteWise
|
|
4485
4604
|
# next_token: "NextToken",
|
4486
4605
|
# max_results: 1,
|
4487
4606
|
# filter: "ALL", # accepts ALL, BASE
|
4607
|
+
# asset_model_version: "AssetModelVersionFilter",
|
4488
4608
|
# })
|
4489
4609
|
#
|
4490
4610
|
# @example Response structure
|
4491
4611
|
#
|
4492
4612
|
# resp.asset_model_property_summaries #=> Array
|
4493
4613
|
# resp.asset_model_property_summaries[0].id #=> String
|
4614
|
+
# resp.asset_model_property_summaries[0].external_id #=> String
|
4494
4615
|
# resp.asset_model_property_summaries[0].name #=> String
|
4495
4616
|
# resp.asset_model_property_summaries[0].data_type #=> String, one of "STRING", "INTEGER", "DOUBLE", "BOOLEAN", "STRUCT"
|
4496
4617
|
# resp.asset_model_property_summaries[0].data_type_spec #=> String
|
@@ -4522,7 +4643,6 @@ module Aws::IoTSiteWise
|
|
4522
4643
|
# resp.asset_model_property_summaries[0].path #=> Array
|
4523
4644
|
# resp.asset_model_property_summaries[0].path[0].id #=> String
|
4524
4645
|
# resp.asset_model_property_summaries[0].path[0].name #=> String
|
4525
|
-
# resp.asset_model_property_summaries[0].external_id #=> String
|
4526
4646
|
# resp.next_token #=> String
|
4527
4647
|
#
|
4528
4648
|
# @overload list_asset_model_properties(params = {})
|
@@ -4534,6 +4654,17 @@ module Aws::IoTSiteWise
|
|
4534
4654
|
|
4535
4655
|
# Retrieves a paginated list of summaries of all asset models.
|
4536
4656
|
#
|
4657
|
+
# @option params [Array<String>] :asset_model_types
|
4658
|
+
# The type of asset model. If you don't provide an `assetModelTypes`,
|
4659
|
+
# all types of asset models are returned.
|
4660
|
+
#
|
4661
|
+
# * **ASSET\_MODEL** – An asset model that you can use to create assets.
|
4662
|
+
# Can't be included as a component in another asset model.
|
4663
|
+
#
|
4664
|
+
# * **COMPONENT\_MODEL** – A reusable component that you can include in
|
4665
|
+
# the composite models of other asset models. You can't create assets
|
4666
|
+
# directly from this type of asset model.
|
4667
|
+
#
|
4537
4668
|
# @option params [String] :next_token
|
4538
4669
|
# The token to be used for the next set of paginated results.
|
4539
4670
|
#
|
@@ -4542,16 +4673,15 @@ module Aws::IoTSiteWise
|
|
4542
4673
|
#
|
4543
4674
|
# Default: 50
|
4544
4675
|
#
|
4545
|
-
# @option params [
|
4546
|
-
# The
|
4676
|
+
# @option params [String] :asset_model_version
|
4677
|
+
# The version alias that specifies the latest or active version of the
|
4678
|
+
# asset model. The details are returned in the response. The default
|
4679
|
+
# value is `LATEST`. See [ Asset model versions][1] in the *IoT SiteWise
|
4680
|
+
# User Guide*.
|
4547
4681
|
#
|
4548
|
-
# * **ASSET\_MODEL** – (default) An asset model that you can use to
|
4549
|
-
# create assets. Can't be included as a component in another asset
|
4550
|
-
# model.
|
4551
4682
|
#
|
4552
|
-
#
|
4553
|
-
#
|
4554
|
-
# directly from this type of asset model.
|
4683
|
+
#
|
4684
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/model-active-version.html
|
4555
4685
|
#
|
4556
4686
|
# @return [Types::ListAssetModelsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4557
4687
|
#
|
@@ -4563,17 +4693,20 @@ module Aws::IoTSiteWise
|
|
4563
4693
|
# @example Request syntax with placeholder values
|
4564
4694
|
#
|
4565
4695
|
# resp = client.list_asset_models({
|
4696
|
+
# asset_model_types: ["ASSET_MODEL"], # accepts ASSET_MODEL, COMPONENT_MODEL
|
4566
4697
|
# next_token: "NextToken",
|
4567
4698
|
# max_results: 1,
|
4568
|
-
#
|
4699
|
+
# asset_model_version: "AssetModelVersionFilter",
|
4569
4700
|
# })
|
4570
4701
|
#
|
4571
4702
|
# @example Response structure
|
4572
4703
|
#
|
4573
4704
|
# resp.asset_model_summaries #=> Array
|
4574
4705
|
# resp.asset_model_summaries[0].id #=> String
|
4706
|
+
# resp.asset_model_summaries[0].external_id #=> String
|
4575
4707
|
# resp.asset_model_summaries[0].arn #=> String
|
4576
4708
|
# resp.asset_model_summaries[0].name #=> String
|
4709
|
+
# resp.asset_model_summaries[0].asset_model_type #=> String, one of "ASSET_MODEL", "COMPONENT_MODEL"
|
4577
4710
|
# resp.asset_model_summaries[0].description #=> String
|
4578
4711
|
# resp.asset_model_summaries[0].creation_date #=> Time
|
4579
4712
|
# resp.asset_model_summaries[0].last_update_date #=> Time
|
@@ -4583,8 +4716,7 @@ module Aws::IoTSiteWise
|
|
4583
4716
|
# resp.asset_model_summaries[0].status.error.details #=> Array
|
4584
4717
|
# resp.asset_model_summaries[0].status.error.details[0].code #=> String, one of "INCOMPATIBLE_COMPUTE_LOCATION", "INCOMPATIBLE_FORWARDING_CONFIGURATION"
|
4585
4718
|
# resp.asset_model_summaries[0].status.error.details[0].message #=> String
|
4586
|
-
# resp.asset_model_summaries[0].
|
4587
|
-
# resp.asset_model_summaries[0].external_id #=> String
|
4719
|
+
# resp.asset_model_summaries[0].version #=> String
|
4588
4720
|
# resp.next_token #=> String
|
4589
4721
|
#
|
4590
4722
|
# @overload list_asset_models(params = {})
|
@@ -4825,10 +4957,9 @@ module Aws::IoTSiteWise
|
|
4825
4957
|
#
|
4826
4958
|
# You can use this operation to do the following:
|
4827
4959
|
#
|
4828
|
-
# * List child assets associated to
|
4829
|
-
# you specify.
|
4960
|
+
# * `CHILD` - List all child assets associated to the asset.
|
4830
4961
|
#
|
4831
|
-
# * List
|
4962
|
+
# * `PARENT` - List the asset's parent asset.
|
4832
4963
|
#
|
4833
4964
|
# @option params [required, String] :asset_id
|
4834
4965
|
# The ID of the asset to query. This can be either the actual ID in UUID
|
@@ -4841,31 +4972,29 @@ module Aws::IoTSiteWise
|
|
4841
4972
|
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references
|
4842
4973
|
#
|
4843
4974
|
# @option params [String] :hierarchy_id
|
4975
|
+
# (Optional) If you don't provide a `hierarchyId`, all the immediate
|
4976
|
+
# assets in the `traversalDirection` will be returned.
|
4977
|
+
#
|
4844
4978
|
# The ID of the hierarchy by which child assets are associated to the
|
4845
4979
|
# asset. (This can be either the actual ID in UUID format, or else
|
4846
4980
|
# `externalId:` followed by the external ID, if it has one. For more
|
4847
4981
|
# information, see [Referencing objects with external IDs][1] in the
|
4848
|
-
# *IoT SiteWise User Guide*.)
|
4849
|
-
# [DescribeAsset][2] or [DescribeAssetModel][3] operations. This
|
4850
|
-
# parameter is required if you choose `CHILD` for `traversalDirection`.
|
4982
|
+
# *IoT SiteWise User Guide*.)
|
4851
4983
|
#
|
4852
|
-
# For more information, see [Asset hierarchies][
|
4984
|
+
# For more information, see [Asset hierarchies][2] in the *IoT SiteWise
|
4853
4985
|
# User Guide*.
|
4854
4986
|
#
|
4855
4987
|
#
|
4856
4988
|
#
|
4857
4989
|
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references
|
4858
|
-
# [2]: https://docs.aws.amazon.com/iot-sitewise/latest/
|
4859
|
-
# [3]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAssetModel.html
|
4860
|
-
# [4]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html
|
4990
|
+
# [2]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html
|
4861
4991
|
#
|
4862
4992
|
# @option params [String] :traversal_direction
|
4863
4993
|
# The direction to list associated assets. Choose one of the following
|
4864
4994
|
# options:
|
4865
4995
|
#
|
4866
4996
|
# * `CHILD` – The list includes all child assets associated to the
|
4867
|
-
# asset.
|
4868
|
-
# `CHILD`.
|
4997
|
+
# asset.
|
4869
4998
|
#
|
4870
4999
|
# * `PARENT` – The list includes the asset's parent asset.
|
4871
5000
|
#
|
@@ -5758,6 +5887,16 @@ module Aws::IoTSiteWise
|
|
5758
5887
|
#
|
5759
5888
|
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references
|
5760
5889
|
#
|
5890
|
+
# @option params [String] :asset_model_external_id
|
5891
|
+
# An external ID to assign to the asset model. The asset model must not
|
5892
|
+
# already have an external ID. The external ID must be unique within
|
5893
|
+
# your Amazon Web Services account. For more information, see [Using
|
5894
|
+
# external IDs][1] in the *IoT SiteWise User Guide*.
|
5895
|
+
#
|
5896
|
+
#
|
5897
|
+
#
|
5898
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
|
5899
|
+
#
|
5761
5900
|
# @option params [required, String] :asset_model_name
|
5762
5901
|
# A unique name for the asset model.
|
5763
5902
|
#
|
@@ -5819,15 +5958,26 @@ module Aws::IoTSiteWise
|
|
5819
5958
|
# **A suitable default value is auto-generated.** You should normally
|
5820
5959
|
# not need to pass this option.**
|
5821
5960
|
#
|
5822
|
-
# @option params [String] :
|
5823
|
-
#
|
5824
|
-
#
|
5825
|
-
#
|
5826
|
-
#
|
5961
|
+
# @option params [String] :if_match
|
5962
|
+
# The expected current entity tag (ETag) for the asset model’s latest or
|
5963
|
+
# active version (specified using `matchForVersionType`). The update
|
5964
|
+
# request is rejected if the tag does not match the latest or active
|
5965
|
+
# version's current entity tag. See [Optimistic locking for asset model
|
5966
|
+
# writes][1] in the *IoT SiteWise User Guide*.
|
5827
5967
|
#
|
5828
5968
|
#
|
5829
5969
|
#
|
5830
|
-
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/
|
5970
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/opt-locking-for-model.html
|
5971
|
+
#
|
5972
|
+
# @option params [String] :if_none_match
|
5973
|
+
# Accepts ***** to reject the update request if an active version
|
5974
|
+
# (specified using `matchForVersionType` as `ACTIVE`) already exists for
|
5975
|
+
# the asset model.
|
5976
|
+
#
|
5977
|
+
# @option params [String] :match_for_version_type
|
5978
|
+
# Specifies the asset model version type (`LATEST` or `ACTIVE`) used in
|
5979
|
+
# conjunction with `If-Match` or `If-None-Match` headers to determine
|
5980
|
+
# the target ETag for the update operation.
|
5831
5981
|
#
|
5832
5982
|
# @return [Types::UpdateAssetModelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5833
5983
|
#
|
@@ -5837,11 +5987,13 @@ module Aws::IoTSiteWise
|
|
5837
5987
|
#
|
5838
5988
|
# resp = client.update_asset_model({
|
5839
5989
|
# asset_model_id: "CustomID", # required
|
5990
|
+
# asset_model_external_id: "ExternalId",
|
5840
5991
|
# asset_model_name: "Name", # required
|
5841
5992
|
# asset_model_description: "Description",
|
5842
5993
|
# asset_model_properties: [
|
5843
5994
|
# {
|
5844
5995
|
# id: "CustomID",
|
5996
|
+
# external_id: "ExternalId",
|
5845
5997
|
# name: "Name", # required
|
5846
5998
|
# data_type: "STRING", # required, accepts STRING, INTEGER, DOUBLE, BOOLEAN, STRUCT
|
5847
5999
|
# data_type_spec: "Name",
|
@@ -5915,15 +6067,14 @@ module Aws::IoTSiteWise
|
|
5915
6067
|
# name: "Name",
|
5916
6068
|
# },
|
5917
6069
|
# ],
|
5918
|
-
# external_id: "ExternalId",
|
5919
6070
|
# },
|
5920
6071
|
# ],
|
5921
6072
|
# asset_model_hierarchies: [
|
5922
6073
|
# {
|
5923
6074
|
# id: "CustomID",
|
6075
|
+
# external_id: "ExternalId",
|
5924
6076
|
# name: "Name", # required
|
5925
6077
|
# child_asset_model_id: "CustomID", # required
|
5926
|
-
# external_id: "ExternalId",
|
5927
6078
|
# },
|
5928
6079
|
# ],
|
5929
6080
|
# asset_model_composite_models: [
|
@@ -5934,6 +6085,7 @@ module Aws::IoTSiteWise
|
|
5934
6085
|
# properties: [
|
5935
6086
|
# {
|
5936
6087
|
# id: "CustomID",
|
6088
|
+
# external_id: "ExternalId",
|
5937
6089
|
# name: "Name", # required
|
5938
6090
|
# data_type: "STRING", # required, accepts STRING, INTEGER, DOUBLE, BOOLEAN, STRUCT
|
5939
6091
|
# data_type_spec: "Name",
|
@@ -6007,7 +6159,6 @@ module Aws::IoTSiteWise
|
|
6007
6159
|
# name: "Name",
|
6008
6160
|
# },
|
6009
6161
|
# ],
|
6010
|
-
# external_id: "ExternalId",
|
6011
6162
|
# },
|
6012
6163
|
# ],
|
6013
6164
|
# id: "CustomID",
|
@@ -6015,7 +6166,9 @@ module Aws::IoTSiteWise
|
|
6015
6166
|
# },
|
6016
6167
|
# ],
|
6017
6168
|
# client_token: "ClientToken",
|
6018
|
-
#
|
6169
|
+
# if_match: "ETag",
|
6170
|
+
# if_none_match: "SelectAll",
|
6171
|
+
# match_for_version_type: "LATEST", # accepts LATEST, ACTIVE
|
6019
6172
|
# })
|
6020
6173
|
#
|
6021
6174
|
# @example Response structure
|
@@ -6098,6 +6251,27 @@ module Aws::IoTSiteWise
|
|
6098
6251
|
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/custom-composite-models.html#inline-composite-models
|
6099
6252
|
# [2]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html
|
6100
6253
|
#
|
6254
|
+
# @option params [String] :if_match
|
6255
|
+
# The expected current entity tag (ETag) for the asset model’s latest or
|
6256
|
+
# active version (specified using `matchForVersionType`). The update
|
6257
|
+
# request is rejected if the tag does not match the latest or active
|
6258
|
+
# version's current entity tag. See [Optimistic locking for asset model
|
6259
|
+
# writes][1] in the *IoT SiteWise User Guide*.
|
6260
|
+
#
|
6261
|
+
#
|
6262
|
+
#
|
6263
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/opt-locking-for-model.html
|
6264
|
+
#
|
6265
|
+
# @option params [String] :if_none_match
|
6266
|
+
# Accepts ***** to reject the update request if an active version
|
6267
|
+
# (specified using `matchForVersionType` as `ACTIVE`) already exists for
|
6268
|
+
# the asset model.
|
6269
|
+
#
|
6270
|
+
# @option params [String] :match_for_version_type
|
6271
|
+
# Specifies the asset model version type (`LATEST` or `ACTIVE`) used in
|
6272
|
+
# conjunction with `If-Match` or `If-None-Match` headers to determine
|
6273
|
+
# the target ETag for the update operation.
|
6274
|
+
#
|
6101
6275
|
# @return [Types::UpdateAssetModelCompositeModelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6102
6276
|
#
|
6103
6277
|
# * {Types::UpdateAssetModelCompositeModelResponse#asset_model_composite_model_path #asset_model_composite_model_path} => Array<Types::AssetModelCompositeModelPathSegment>
|
@@ -6115,6 +6289,7 @@ module Aws::IoTSiteWise
|
|
6115
6289
|
# asset_model_composite_model_properties: [
|
6116
6290
|
# {
|
6117
6291
|
# id: "CustomID",
|
6292
|
+
# external_id: "ExternalId",
|
6118
6293
|
# name: "Name", # required
|
6119
6294
|
# data_type: "STRING", # required, accepts STRING, INTEGER, DOUBLE, BOOLEAN, STRUCT
|
6120
6295
|
# data_type_spec: "Name",
|
@@ -6188,9 +6363,11 @@ module Aws::IoTSiteWise
|
|
6188
6363
|
# name: "Name",
|
6189
6364
|
# },
|
6190
6365
|
# ],
|
6191
|
-
# external_id: "ExternalId",
|
6192
6366
|
# },
|
6193
6367
|
# ],
|
6368
|
+
# if_match: "ETag",
|
6369
|
+
# if_none_match: "SelectAll",
|
6370
|
+
# match_for_version_type: "LATEST", # accepts LATEST, ACTIVE
|
6194
6371
|
# })
|
6195
6372
|
#
|
6196
6373
|
# @example Response structure
|
@@ -6576,7 +6753,7 @@ module Aws::IoTSiteWise
|
|
6576
6753
|
params: params,
|
6577
6754
|
config: config)
|
6578
6755
|
context[:gem_name] = 'aws-sdk-iotsitewise'
|
6579
|
-
context[:gem_version] = '1.
|
6756
|
+
context[:gem_version] = '1.69.0'
|
6580
6757
|
Seahorse::Client::Request.new(handlers, context)
|
6581
6758
|
end
|
6582
6759
|
|