aws-sdk-iotsitewise 1.67.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.
@@ -1152,7 +1152,34 @@ module Aws::IoTSiteWise
1152
1152
  # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/define-models.html
1153
1153
  #
1154
1154
  # @option params [required, String] :asset_model_name
1155
- # A unique, friendly name for the asset model.
1155
+ # A unique name for the asset model.
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
1156
1183
  #
1157
1184
  # @option params [String] :asset_model_description
1158
1185
  # A description for the asset model.
@@ -1193,13 +1220,15 @@ module Aws::IoTSiteWise
1193
1220
  #
1194
1221
  # <note markdown="1"> When creating custom composite models, you need to use
1195
1222
  # [CreateAssetModelCompositeModel][1]. For more information, see
1196
- # &lt;LINK&gt;.
1223
+ # [Creating custom composite models (Components)][2] in the *IoT
1224
+ # SiteWise User Guide*.
1197
1225
  #
1198
1226
  # </note>
1199
1227
  #
1200
1228
  #
1201
1229
  #
1202
1230
  # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModelCompositeModel.html
1231
+ # [2]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-custom-composite-models.html
1203
1232
  #
1204
1233
  # @option params [String] :client_token
1205
1234
  # A unique case-sensitive identifier that you can provide to ensure the
@@ -1218,33 +1247,6 @@ module Aws::IoTSiteWise
1218
1247
  #
1219
1248
  # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html
1220
1249
  #
1221
- # @option params [String] :asset_model_id
1222
- # The ID to assign to the asset model, if desired. IoT SiteWise
1223
- # automatically generates a unique ID for you, so this parameter is
1224
- # never required. However, if you prefer to supply your own ID instead,
1225
- # you can specify it here in UUID format. If you specify your own ID, it
1226
- # must be globally unique.
1227
- #
1228
- # @option params [String] :asset_model_external_id
1229
- # An external ID to assign to the asset model. The external ID must be
1230
- # unique within your Amazon Web Services account. For more information,
1231
- # see [Using external IDs][1] in the *IoT SiteWise User Guide*.
1232
- #
1233
- #
1234
- #
1235
- # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
1236
- #
1237
- # @option params [String] :asset_model_type
1238
- # The type of asset model.
1239
- #
1240
- # * **ASSET\_MODEL** – (default) An asset model that you can use to
1241
- # create assets. Can't be included as a component in another asset
1242
- # model.
1243
- #
1244
- # * **COMPONENT\_MODEL** – A reusable component that you can include in
1245
- # the composite models of other asset models. You can't create assets
1246
- # directly from this type of asset model.
1247
- #
1248
1250
  # @return [Types::CreateAssetModelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1249
1251
  #
1250
1252
  # * {Types::CreateAssetModelResponse#asset_model_id #asset_model_id} => String
@@ -1255,9 +1257,14 @@ module Aws::IoTSiteWise
1255
1257
  #
1256
1258
  # resp = client.create_asset_model({
1257
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",
1258
1263
  # asset_model_description: "Description",
1259
1264
  # asset_model_properties: [
1260
1265
  # {
1266
+ # id: "ID",
1267
+ # external_id: "ExternalId",
1261
1268
  # name: "Name", # required
1262
1269
  # data_type: "STRING", # required, accepts STRING, INTEGER, DOUBLE, BOOLEAN, STRUCT
1263
1270
  # data_type_spec: "Name",
@@ -1325,25 +1332,27 @@ module Aws::IoTSiteWise
1325
1332
  # },
1326
1333
  # },
1327
1334
  # },
1328
- # id: "ID",
1329
- # external_id: "ExternalId",
1330
1335
  # },
1331
1336
  # ],
1332
1337
  # asset_model_hierarchies: [
1333
1338
  # {
1334
- # name: "Name", # required
1335
- # child_asset_model_id: "CustomID", # required
1336
1339
  # id: "ID",
1337
1340
  # external_id: "ExternalId",
1341
+ # name: "Name", # required
1342
+ # child_asset_model_id: "CustomID", # required
1338
1343
  # },
1339
1344
  # ],
1340
1345
  # asset_model_composite_models: [
1341
1346
  # {
1347
+ # id: "ID",
1348
+ # external_id: "ExternalId",
1342
1349
  # name: "Name", # required
1343
1350
  # description: "Description",
1344
1351
  # type: "Name", # required
1345
1352
  # properties: [
1346
1353
  # {
1354
+ # id: "ID",
1355
+ # external_id: "ExternalId",
1347
1356
  # name: "Name", # required
1348
1357
  # data_type: "STRING", # required, accepts STRING, INTEGER, DOUBLE, BOOLEAN, STRUCT
1349
1358
  # data_type_spec: "Name",
@@ -1411,21 +1420,14 @@ module Aws::IoTSiteWise
1411
1420
  # },
1412
1421
  # },
1413
1422
  # },
1414
- # id: "ID",
1415
- # external_id: "ExternalId",
1416
1423
  # },
1417
1424
  # ],
1418
- # id: "ID",
1419
- # external_id: "ExternalId",
1420
1425
  # },
1421
1426
  # ],
1422
1427
  # client_token: "ClientToken",
1423
1428
  # tags: {
1424
1429
  # "TagKey" => "TagValue",
1425
1430
  # },
1426
- # asset_model_id: "ID",
1427
- # asset_model_external_id: "ExternalId",
1428
- # asset_model_type: "ASSET_MODEL", # accepts ASSET_MODEL, COMPONENT_MODEL
1429
1431
  # })
1430
1432
  #
1431
1433
  # @example Response structure
@@ -1479,9 +1481,6 @@ module Aws::IoTSiteWise
1479
1481
  # @option params [required, String] :asset_model_id
1480
1482
  # The ID of the asset model this composite model is a part of.
1481
1483
  #
1482
- # @option params [String] :parent_asset_model_composite_model_id
1483
- # The ID of the parent composite model in this asset model relationship.
1484
- #
1485
1484
  # @option params [String] :asset_model_composite_model_external_id
1486
1485
  # An external ID to assign to the composite model.
1487
1486
  #
@@ -1490,6 +1489,9 @@ module Aws::IoTSiteWise
1490
1489
  # `UpdateAssetModelCompositeModel` and specifying the derived ID of the
1491
1490
  # model or property from the created model it's a part of.
1492
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
+ #
1493
1495
  # @option params [String] :asset_model_composite_model_id
1494
1496
  # The ID of the composite model. IoT SiteWise automatically generates a
1495
1497
  # unique ID for you, so this parameter is never required. However, if
@@ -1500,7 +1502,7 @@ module Aws::IoTSiteWise
1500
1502
  # A description for the composite model.
1501
1503
  #
1502
1504
  # @option params [required, String] :asset_model_composite_model_name
1503
- # A unique, friendly name for the composite model.
1505
+ # A unique name for the composite model.
1504
1506
  #
1505
1507
  # @option params [required, String] :asset_model_composite_model_type
1506
1508
  # The composite model type. Valid values are `AWS/ALARM`, `CUSTOM`, or `
@@ -1515,18 +1517,42 @@ module Aws::IoTSiteWise
1515
1517
  # not need to pass this option.**
1516
1518
  #
1517
1519
  # @option params [String] :composed_asset_model_id
1518
- # The ID of a composite model on this asset.
1520
+ # The ID of a component model which is reused to create this composite
1521
+ # model.
1519
1522
  #
1520
1523
  # @option params [Array<Types::AssetModelPropertyDefinition>] :asset_model_composite_model_properties
1521
1524
  # The property definitions of the composite model. For more information,
1522
- # see &lt;LINK&gt;.
1525
+ # see [ Inline custom composite models][1] in the *IoT SiteWise User
1526
+ # Guide*.
1523
1527
  #
1524
1528
  # You can specify up to 200 properties per composite model. For more
1525
- # information, see [Quotas][1] in the *IoT SiteWise User Guide*.
1529
+ # information, see [Quotas][2] in the *IoT SiteWise User Guide*.
1530
+ #
1531
+ #
1532
+ #
1533
+ # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/custom-composite-models.html#inline-composite-models
1534
+ # [2]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html
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
+ #
1526
1543
  #
1527
1544
  #
1545
+ # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/opt-locking-for-model.html
1528
1546
  #
1529
- # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html
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.
1530
1556
  #
1531
1557
  # @return [Types::CreateAssetModelCompositeModelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1532
1558
  #
@@ -1538,8 +1564,8 @@ module Aws::IoTSiteWise
1538
1564
  #
1539
1565
  # resp = client.create_asset_model_composite_model({
1540
1566
  # asset_model_id: "CustomID", # required
1541
- # parent_asset_model_composite_model_id: "CustomID",
1542
1567
  # asset_model_composite_model_external_id: "ExternalId",
1568
+ # parent_asset_model_composite_model_id: "CustomID",
1543
1569
  # asset_model_composite_model_id: "ID",
1544
1570
  # asset_model_composite_model_description: "Description",
1545
1571
  # asset_model_composite_model_name: "Name", # required
@@ -1548,6 +1574,8 @@ module Aws::IoTSiteWise
1548
1574
  # composed_asset_model_id: "CustomID",
1549
1575
  # asset_model_composite_model_properties: [
1550
1576
  # {
1577
+ # id: "ID",
1578
+ # external_id: "ExternalId",
1551
1579
  # name: "Name", # required
1552
1580
  # data_type: "STRING", # required, accepts STRING, INTEGER, DOUBLE, BOOLEAN, STRUCT
1553
1581
  # data_type_spec: "Name",
@@ -1615,10 +1643,11 @@ module Aws::IoTSiteWise
1615
1643
  # },
1616
1644
  # },
1617
1645
  # },
1618
- # id: "ID",
1619
- # external_id: "ExternalId",
1620
1646
  # },
1621
1647
  # ],
1648
+ # if_match: "ETag",
1649
+ # if_none_match: "SelectAll",
1650
+ # match_for_version_type: "LATEST", # accepts LATEST, ACTIVE
1622
1651
  # })
1623
1652
  #
1624
1653
  # @example Response structure
@@ -1814,7 +1843,7 @@ module Aws::IoTSiteWise
1814
1843
  # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/gateway-connector.html
1815
1844
  #
1816
1845
  # @option params [required, String] :gateway_name
1817
- # A unique, friendly name for the gateway.
1846
+ # A unique name for the gateway.
1818
1847
  #
1819
1848
  # @option params [required, Types::GatewayPlatform] :gateway_platform
1820
1849
  # The gateway's platform. You can only specify one platform in a
@@ -1837,7 +1866,7 @@ module Aws::IoTSiteWise
1837
1866
  # @example Request syntax with placeholder values
1838
1867
  #
1839
1868
  # resp = client.create_gateway({
1840
- # gateway_name: "Name", # required
1869
+ # gateway_name: "GatewayName", # required
1841
1870
  # gateway_platform: { # required
1842
1871
  # greengrass: {
1843
1872
  # group_arn: "ARN", # required
@@ -1845,6 +1874,9 @@ module Aws::IoTSiteWise
1845
1874
  # greengrass_v2: {
1846
1875
  # core_device_thing_name: "CoreDeviceThingName", # required
1847
1876
  # },
1877
+ # siemens_ie: {
1878
+ # iot_core_thing_name: "IotCoreThingName", # required
1879
+ # },
1848
1880
  # },
1849
1881
  # tags: {
1850
1882
  # "TagKey" => "TagValue",
@@ -2190,6 +2222,27 @@ module Aws::IoTSiteWise
2190
2222
  # **A suitable default value is auto-generated.** You should normally
2191
2223
  # not need to pass this option.**
2192
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
+ #
2193
2246
  # @return [Types::DeleteAssetModelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2194
2247
  #
2195
2248
  # * {Types::DeleteAssetModelResponse#asset_model_status #asset_model_status} => Types::AssetModelStatus
@@ -2199,6 +2252,9 @@ module Aws::IoTSiteWise
2199
2252
  # resp = client.delete_asset_model({
2200
2253
  # asset_model_id: "CustomID", # required
2201
2254
  # client_token: "ClientToken",
2255
+ # if_match: "ETag",
2256
+ # if_none_match: "SelectAll",
2257
+ # match_for_version_type: "LATEST", # accepts LATEST, ACTIVE
2202
2258
  # })
2203
2259
  #
2204
2260
  # @example Response structure
@@ -2242,6 +2298,27 @@ module Aws::IoTSiteWise
2242
2298
  # **A suitable default value is auto-generated.** You should normally
2243
2299
  # not need to pass this option.**
2244
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
+ #
2245
2322
  # @return [Types::DeleteAssetModelCompositeModelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2246
2323
  #
2247
2324
  # * {Types::DeleteAssetModelCompositeModelResponse#asset_model_status #asset_model_status} => Types::AssetModelStatus
@@ -2252,6 +2329,9 @@ module Aws::IoTSiteWise
2252
2329
  # asset_model_id: "CustomID", # required
2253
2330
  # asset_model_composite_model_id: "CustomID", # required
2254
2331
  # client_token: "ClientToken",
2332
+ # if_match: "ETag",
2333
+ # if_none_match: "SelectAll",
2334
+ # match_for_version_type: "LATEST", # accepts LATEST, ACTIVE
2255
2335
  # })
2256
2336
  #
2257
2337
  # @example Response structure
@@ -2752,37 +2832,53 @@ module Aws::IoTSiteWise
2752
2832
  # @option params [Boolean] :exclude_properties
2753
2833
  # Whether or not to exclude asset model properties from the response.
2754
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
+ #
2755
2845
  # @return [Types::DescribeAssetModelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2756
2846
  #
2757
2847
  # * {Types::DescribeAssetModelResponse#asset_model_id #asset_model_id} => String
2848
+ # * {Types::DescribeAssetModelResponse#asset_model_external_id #asset_model_external_id} => String
2758
2849
  # * {Types::DescribeAssetModelResponse#asset_model_arn #asset_model_arn} => String
2759
2850
  # * {Types::DescribeAssetModelResponse#asset_model_name #asset_model_name} => String
2851
+ # * {Types::DescribeAssetModelResponse#asset_model_type #asset_model_type} => String
2760
2852
  # * {Types::DescribeAssetModelResponse#asset_model_description #asset_model_description} => String
2761
2853
  # * {Types::DescribeAssetModelResponse#asset_model_properties #asset_model_properties} => Array&lt;Types::AssetModelProperty&gt;
2762
2854
  # * {Types::DescribeAssetModelResponse#asset_model_hierarchies #asset_model_hierarchies} => Array&lt;Types::AssetModelHierarchy&gt;
2763
2855
  # * {Types::DescribeAssetModelResponse#asset_model_composite_models #asset_model_composite_models} => Array&lt;Types::AssetModelCompositeModel&gt;
2856
+ # * {Types::DescribeAssetModelResponse#asset_model_composite_model_summaries #asset_model_composite_model_summaries} => Array&lt;Types::AssetModelCompositeModelSummary&gt;
2764
2857
  # * {Types::DescribeAssetModelResponse#asset_model_creation_date #asset_model_creation_date} => Time
2765
2858
  # * {Types::DescribeAssetModelResponse#asset_model_last_update_date #asset_model_last_update_date} => Time
2766
2859
  # * {Types::DescribeAssetModelResponse#asset_model_status #asset_model_status} => Types::AssetModelStatus
2767
- # * {Types::DescribeAssetModelResponse#asset_model_type #asset_model_type} => String
2768
- # * {Types::DescribeAssetModelResponse#asset_model_composite_model_summaries #asset_model_composite_model_summaries} => Array&lt;Types::AssetModelCompositeModelSummary&gt;
2769
- # * {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
2770
2862
  #
2771
2863
  # @example Request syntax with placeholder values
2772
2864
  #
2773
2865
  # resp = client.describe_asset_model({
2774
2866
  # asset_model_id: "CustomID", # required
2775
2867
  # exclude_properties: false,
2868
+ # asset_model_version: "AssetModelVersionFilter",
2776
2869
  # })
2777
2870
  #
2778
2871
  # @example Response structure
2779
2872
  #
2780
2873
  # resp.asset_model_id #=> String
2874
+ # resp.asset_model_external_id #=> String
2781
2875
  # resp.asset_model_arn #=> String
2782
2876
  # resp.asset_model_name #=> String
2877
+ # resp.asset_model_type #=> String, one of "ASSET_MODEL", "COMPONENT_MODEL"
2783
2878
  # resp.asset_model_description #=> String
2784
2879
  # resp.asset_model_properties #=> Array
2785
2880
  # resp.asset_model_properties[0].id #=> String
2881
+ # resp.asset_model_properties[0].external_id #=> String
2786
2882
  # resp.asset_model_properties[0].name #=> String
2787
2883
  # resp.asset_model_properties[0].data_type #=> String, one of "STRING", "INTEGER", "DOUBLE", "BOOLEAN", "STRUCT"
2788
2884
  # resp.asset_model_properties[0].data_type_spec #=> String
@@ -2813,18 +2909,18 @@ module Aws::IoTSiteWise
2813
2909
  # resp.asset_model_properties[0].path #=> Array
2814
2910
  # resp.asset_model_properties[0].path[0].id #=> String
2815
2911
  # resp.asset_model_properties[0].path[0].name #=> String
2816
- # resp.asset_model_properties[0].external_id #=> String
2817
2912
  # resp.asset_model_hierarchies #=> Array
2818
2913
  # resp.asset_model_hierarchies[0].id #=> String
2914
+ # resp.asset_model_hierarchies[0].external_id #=> String
2819
2915
  # resp.asset_model_hierarchies[0].name #=> String
2820
2916
  # resp.asset_model_hierarchies[0].child_asset_model_id #=> String
2821
- # resp.asset_model_hierarchies[0].external_id #=> String
2822
2917
  # resp.asset_model_composite_models #=> Array
2823
2918
  # resp.asset_model_composite_models[0].name #=> String
2824
2919
  # resp.asset_model_composite_models[0].description #=> String
2825
2920
  # resp.asset_model_composite_models[0].type #=> String
2826
2921
  # resp.asset_model_composite_models[0].properties #=> Array
2827
2922
  # resp.asset_model_composite_models[0].properties[0].id #=> String
2923
+ # resp.asset_model_composite_models[0].properties[0].external_id #=> String
2828
2924
  # resp.asset_model_composite_models[0].properties[0].name #=> String
2829
2925
  # resp.asset_model_composite_models[0].properties[0].data_type #=> String, one of "STRING", "INTEGER", "DOUBLE", "BOOLEAN", "STRUCT"
2830
2926
  # resp.asset_model_composite_models[0].properties[0].data_type_spec #=> String
@@ -2855,18 +2951,8 @@ module Aws::IoTSiteWise
2855
2951
  # resp.asset_model_composite_models[0].properties[0].path #=> Array
2856
2952
  # resp.asset_model_composite_models[0].properties[0].path[0].id #=> String
2857
2953
  # resp.asset_model_composite_models[0].properties[0].path[0].name #=> String
2858
- # resp.asset_model_composite_models[0].properties[0].external_id #=> String
2859
2954
  # resp.asset_model_composite_models[0].id #=> String
2860
2955
  # resp.asset_model_composite_models[0].external_id #=> String
2861
- # resp.asset_model_creation_date #=> Time
2862
- # resp.asset_model_last_update_date #=> Time
2863
- # resp.asset_model_status.state #=> String, one of "CREATING", "ACTIVE", "UPDATING", "PROPAGATING", "DELETING", "FAILED"
2864
- # resp.asset_model_status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
2865
- # resp.asset_model_status.error.message #=> String
2866
- # resp.asset_model_status.error.details #=> Array
2867
- # resp.asset_model_status.error.details[0].code #=> String, one of "INCOMPATIBLE_COMPUTE_LOCATION", "INCOMPATIBLE_FORWARDING_CONFIGURATION"
2868
- # resp.asset_model_status.error.details[0].message #=> String
2869
- # resp.asset_model_type #=> String, one of "ASSET_MODEL", "COMPONENT_MODEL"
2870
2956
  # resp.asset_model_composite_model_summaries #=> Array
2871
2957
  # resp.asset_model_composite_model_summaries[0].id #=> String
2872
2958
  # resp.asset_model_composite_model_summaries[0].external_id #=> String
@@ -2876,7 +2962,16 @@ module Aws::IoTSiteWise
2876
2962
  # resp.asset_model_composite_model_summaries[0].path #=> Array
2877
2963
  # resp.asset_model_composite_model_summaries[0].path[0].id #=> String
2878
2964
  # resp.asset_model_composite_model_summaries[0].path[0].name #=> String
2879
- # resp.asset_model_external_id #=> String
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
2880
2975
  #
2881
2976
  #
2882
2977
  # The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
@@ -2919,6 +3014,16 @@ module Aws::IoTSiteWise
2919
3014
  #
2920
3015
  # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references
2921
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
+ #
2922
3027
  # @return [Types::DescribeAssetModelCompositeModelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2923
3028
  #
2924
3029
  # * {Types::DescribeAssetModelCompositeModelResponse#asset_model_id #asset_model_id} => String
@@ -2938,6 +3043,7 @@ module Aws::IoTSiteWise
2938
3043
  # resp = client.describe_asset_model_composite_model({
2939
3044
  # asset_model_id: "CustomID", # required
2940
3045
  # asset_model_composite_model_id: "CustomID", # required
3046
+ # asset_model_version: "AssetModelVersionFilter",
2941
3047
  # })
2942
3048
  #
2943
3049
  # @example Response structure
@@ -2953,6 +3059,7 @@ module Aws::IoTSiteWise
2953
3059
  # resp.asset_model_composite_model_type #=> String
2954
3060
  # resp.asset_model_composite_model_properties #=> Array
2955
3061
  # resp.asset_model_composite_model_properties[0].id #=> String
3062
+ # resp.asset_model_composite_model_properties[0].external_id #=> String
2956
3063
  # resp.asset_model_composite_model_properties[0].name #=> String
2957
3064
  # resp.asset_model_composite_model_properties[0].data_type #=> String, one of "STRING", "INTEGER", "DOUBLE", "BOOLEAN", "STRUCT"
2958
3065
  # resp.asset_model_composite_model_properties[0].data_type_spec #=> String
@@ -2983,7 +3090,6 @@ module Aws::IoTSiteWise
2983
3090
  # resp.asset_model_composite_model_properties[0].path #=> Array
2984
3091
  # resp.asset_model_composite_model_properties[0].path[0].id #=> String
2985
3092
  # resp.asset_model_composite_model_properties[0].path[0].name #=> String
2986
- # resp.asset_model_composite_model_properties[0].external_id #=> String
2987
3093
  # resp.composition_details.composition_relationship #=> Array
2988
3094
  # resp.composition_details.composition_relationship[0].id #=> String
2989
3095
  # resp.asset_model_composite_model_summaries #=> Array
@@ -3300,9 +3406,10 @@ module Aws::IoTSiteWise
3300
3406
  # resp.gateway_arn #=> String
3301
3407
  # resp.gateway_platform.greengrass.group_arn #=> String
3302
3408
  # resp.gateway_platform.greengrass_v2.core_device_thing_name #=> String
3409
+ # resp.gateway_platform.siemens_ie.iot_core_thing_name #=> String
3303
3410
  # resp.gateway_capability_summaries #=> Array
3304
3411
  # resp.gateway_capability_summaries[0].capability_namespace #=> String
3305
- # resp.gateway_capability_summaries[0].capability_sync_status #=> String, one of "IN_SYNC", "OUT_OF_SYNC", "SYNC_FAILED", "UNKNOWN"
3412
+ # resp.gateway_capability_summaries[0].capability_sync_status #=> String, one of "IN_SYNC", "OUT_OF_SYNC", "SYNC_FAILED", "UNKNOWN", "NOT_APPLICABLE"
3306
3413
  # resp.creation_date #=> Time
3307
3414
  # resp.last_update_date #=> Time
3308
3415
  #
@@ -3354,7 +3461,7 @@ module Aws::IoTSiteWise
3354
3461
  # resp.gateway_id #=> String
3355
3462
  # resp.capability_namespace #=> String
3356
3463
  # resp.capability_configuration #=> String
3357
- # resp.capability_sync_status #=> String, one of "IN_SYNC", "OUT_OF_SYNC", "SYNC_FAILED", "UNKNOWN"
3464
+ # resp.capability_sync_status #=> String, one of "IN_SYNC", "OUT_OF_SYNC", "SYNC_FAILED", "UNKNOWN", "NOT_APPLICABLE"
3358
3465
  #
3359
3466
  # @overload describe_gateway_capability_configuration(params = {})
3360
3467
  # @param [Hash] params ({})
@@ -4394,6 +4501,16 @@ module Aws::IoTSiteWise
4394
4501
  #
4395
4502
  # Default: 50
4396
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
+ #
4397
4514
  # @return [Types::ListAssetModelCompositeModelsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4398
4515
  #
4399
4516
  # * {Types::ListAssetModelCompositeModelsResponse#asset_model_composite_model_summaries #asset_model_composite_model_summaries} => Array&lt;Types::AssetModelCompositeModelSummary&gt;
@@ -4407,6 +4524,7 @@ module Aws::IoTSiteWise
4407
4524
  # asset_model_id: "CustomID", # required
4408
4525
  # next_token: "NextToken",
4409
4526
  # max_results: 1,
4527
+ # asset_model_version: "AssetModelVersionFilter",
4410
4528
  # })
4411
4529
  #
4412
4530
  # @example Response structure
@@ -4462,6 +4580,16 @@ module Aws::IoTSiteWise
4462
4580
  #
4463
4581
  # Default: `BASE`
4464
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
+ #
4465
4593
  # @return [Types::ListAssetModelPropertiesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4466
4594
  #
4467
4595
  # * {Types::ListAssetModelPropertiesResponse#asset_model_property_summaries #asset_model_property_summaries} => Array&lt;Types::AssetModelPropertySummary&gt;
@@ -4476,12 +4604,14 @@ module Aws::IoTSiteWise
4476
4604
  # next_token: "NextToken",
4477
4605
  # max_results: 1,
4478
4606
  # filter: "ALL", # accepts ALL, BASE
4607
+ # asset_model_version: "AssetModelVersionFilter",
4479
4608
  # })
4480
4609
  #
4481
4610
  # @example Response structure
4482
4611
  #
4483
4612
  # resp.asset_model_property_summaries #=> Array
4484
4613
  # resp.asset_model_property_summaries[0].id #=> String
4614
+ # resp.asset_model_property_summaries[0].external_id #=> String
4485
4615
  # resp.asset_model_property_summaries[0].name #=> String
4486
4616
  # resp.asset_model_property_summaries[0].data_type #=> String, one of "STRING", "INTEGER", "DOUBLE", "BOOLEAN", "STRUCT"
4487
4617
  # resp.asset_model_property_summaries[0].data_type_spec #=> String
@@ -4513,7 +4643,6 @@ module Aws::IoTSiteWise
4513
4643
  # resp.asset_model_property_summaries[0].path #=> Array
4514
4644
  # resp.asset_model_property_summaries[0].path[0].id #=> String
4515
4645
  # resp.asset_model_property_summaries[0].path[0].name #=> String
4516
- # resp.asset_model_property_summaries[0].external_id #=> String
4517
4646
  # resp.next_token #=> String
4518
4647
  #
4519
4648
  # @overload list_asset_model_properties(params = {})
@@ -4525,6 +4654,17 @@ module Aws::IoTSiteWise
4525
4654
 
4526
4655
  # Retrieves a paginated list of summaries of all asset models.
4527
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
+ #
4528
4668
  # @option params [String] :next_token
4529
4669
  # The token to be used for the next set of paginated results.
4530
4670
  #
@@ -4533,16 +4673,15 @@ module Aws::IoTSiteWise
4533
4673
  #
4534
4674
  # Default: 50
4535
4675
  #
4536
- # @option params [Array<String>] :asset_model_types
4537
- # The type of asset model.
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*.
4538
4681
  #
4539
- # * **ASSET\_MODEL** – (default) An asset model that you can use to
4540
- # create assets. Can't be included as a component in another asset
4541
- # model.
4542
4682
  #
4543
- # * **COMPONENT\_MODEL** – A reusable component that you can include in
4544
- # the composite models of other asset models. You can't create assets
4545
- # directly from this type of asset model.
4683
+ #
4684
+ # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/model-active-version.html
4546
4685
  #
4547
4686
  # @return [Types::ListAssetModelsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4548
4687
  #
@@ -4554,17 +4693,20 @@ module Aws::IoTSiteWise
4554
4693
  # @example Request syntax with placeholder values
4555
4694
  #
4556
4695
  # resp = client.list_asset_models({
4696
+ # asset_model_types: ["ASSET_MODEL"], # accepts ASSET_MODEL, COMPONENT_MODEL
4557
4697
  # next_token: "NextToken",
4558
4698
  # max_results: 1,
4559
- # asset_model_types: ["ASSET_MODEL"], # accepts ASSET_MODEL, COMPONENT_MODEL
4699
+ # asset_model_version: "AssetModelVersionFilter",
4560
4700
  # })
4561
4701
  #
4562
4702
  # @example Response structure
4563
4703
  #
4564
4704
  # resp.asset_model_summaries #=> Array
4565
4705
  # resp.asset_model_summaries[0].id #=> String
4706
+ # resp.asset_model_summaries[0].external_id #=> String
4566
4707
  # resp.asset_model_summaries[0].arn #=> String
4567
4708
  # resp.asset_model_summaries[0].name #=> String
4709
+ # resp.asset_model_summaries[0].asset_model_type #=> String, one of "ASSET_MODEL", "COMPONENT_MODEL"
4568
4710
  # resp.asset_model_summaries[0].description #=> String
4569
4711
  # resp.asset_model_summaries[0].creation_date #=> Time
4570
4712
  # resp.asset_model_summaries[0].last_update_date #=> Time
@@ -4574,8 +4716,7 @@ module Aws::IoTSiteWise
4574
4716
  # resp.asset_model_summaries[0].status.error.details #=> Array
4575
4717
  # resp.asset_model_summaries[0].status.error.details[0].code #=> String, one of "INCOMPATIBLE_COMPUTE_LOCATION", "INCOMPATIBLE_FORWARDING_CONFIGURATION"
4576
4718
  # resp.asset_model_summaries[0].status.error.details[0].message #=> String
4577
- # resp.asset_model_summaries[0].asset_model_type #=> String, one of "ASSET_MODEL", "COMPONENT_MODEL"
4578
- # resp.asset_model_summaries[0].external_id #=> String
4719
+ # resp.asset_model_summaries[0].version #=> String
4579
4720
  # resp.next_token #=> String
4580
4721
  #
4581
4722
  # @overload list_asset_models(params = {})
@@ -4816,10 +4957,9 @@ module Aws::IoTSiteWise
4816
4957
  #
4817
4958
  # You can use this operation to do the following:
4818
4959
  #
4819
- # * List child assets associated to a parent asset by a hierarchy that
4820
- # you specify.
4960
+ # * `CHILD` - List all child assets associated to the asset.
4821
4961
  #
4822
- # * List an asset's parent asset.
4962
+ # * `PARENT` - List the asset's parent asset.
4823
4963
  #
4824
4964
  # @option params [required, String] :asset_id
4825
4965
  # The ID of the asset to query. This can be either the actual ID in UUID
@@ -4832,31 +4972,29 @@ module Aws::IoTSiteWise
4832
4972
  # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references
4833
4973
  #
4834
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
+ #
4835
4978
  # The ID of the hierarchy by which child assets are associated to the
4836
4979
  # asset. (This can be either the actual ID in UUID format, or else
4837
4980
  # `externalId:` followed by the external ID, if it has one. For more
4838
4981
  # information, see [Referencing objects with external IDs][1] in the
4839
- # *IoT SiteWise User Guide*.) To find a hierarchy ID, use the
4840
- # [DescribeAsset][2] or [DescribeAssetModel][3] operations. This
4841
- # parameter is required if you choose `CHILD` for `traversalDirection`.
4982
+ # *IoT SiteWise User Guide*.)
4842
4983
  #
4843
- # For more information, see [Asset hierarchies][4] in the *IoT SiteWise
4984
+ # For more information, see [Asset hierarchies][2] in the *IoT SiteWise
4844
4985
  # User Guide*.
4845
4986
  #
4846
4987
  #
4847
4988
  #
4848
4989
  # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references
4849
- # [2]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAsset.html
4850
- # [3]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAssetModel.html
4851
- # [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
4852
4991
  #
4853
4992
  # @option params [String] :traversal_direction
4854
4993
  # The direction to list associated assets. Choose one of the following
4855
4994
  # options:
4856
4995
  #
4857
4996
  # * `CHILD` – The list includes all child assets associated to the
4858
- # asset. The `hierarchyId` parameter is required if you choose
4859
- # `CHILD`.
4997
+ # asset.
4860
4998
  #
4861
4999
  # * `PARENT` – The list includes the asset's parent asset.
4862
5000
  #
@@ -5093,9 +5231,10 @@ module Aws::IoTSiteWise
5093
5231
  # resp.gateway_summaries[0].gateway_name #=> String
5094
5232
  # resp.gateway_summaries[0].gateway_platform.greengrass.group_arn #=> String
5095
5233
  # resp.gateway_summaries[0].gateway_platform.greengrass_v2.core_device_thing_name #=> String
5234
+ # resp.gateway_summaries[0].gateway_platform.siemens_ie.iot_core_thing_name #=> String
5096
5235
  # resp.gateway_summaries[0].gateway_capability_summaries #=> Array
5097
5236
  # resp.gateway_summaries[0].gateway_capability_summaries[0].capability_namespace #=> String
5098
- # resp.gateway_summaries[0].gateway_capability_summaries[0].capability_sync_status #=> String, one of "IN_SYNC", "OUT_OF_SYNC", "SYNC_FAILED", "UNKNOWN"
5237
+ # resp.gateway_summaries[0].gateway_capability_summaries[0].capability_sync_status #=> String, one of "IN_SYNC", "OUT_OF_SYNC", "SYNC_FAILED", "UNKNOWN", "NOT_APPLICABLE"
5099
5238
  # resp.gateway_summaries[0].creation_date #=> Time
5100
5239
  # resp.gateway_summaries[0].last_update_date #=> Time
5101
5240
  # resp.next_token #=> String
@@ -5720,22 +5859,23 @@ module Aws::IoTSiteWise
5720
5859
  # information, see [Updating assets and models][1] in the *IoT SiteWise
5721
5860
  # User Guide*.
5722
5861
  #
5723
- # This operation overwrites the existing model with the provided model.
5724
- # To avoid deleting your asset model's properties or hierarchies, you
5725
- # must include their IDs and definitions in the updated asset model
5726
- # payload. For more information, see [DescribeAssetModel][2].
5862
+ # If you remove a property from an asset model, IoT SiteWise deletes all
5863
+ # previous data for that property. You can’t change the type or data
5864
+ # type of an existing property.
5865
+ #
5866
+ # To replace an existing asset model property with a new one with the
5867
+ # same `name`, do the following:
5727
5868
  #
5728
- # If you remove a property from an asset model, IoT SiteWise deletes
5729
- # all
5730
- # previous data for that property. If you remove a hierarchy definition
5731
- # from an asset model, IoT SiteWise disassociates every asset associated
5732
- # with that hierarchy. You can't change the type or data type of an
5733
- # existing property.
5869
+ # 1. Submit an `UpdateAssetModel` request with the entire existing
5870
+ # property removed.
5871
+ #
5872
+ # 2. Submit a second `UpdateAssetModel` request that includes the new
5873
+ # property. The new asset property will have the same `name` as the
5874
+ # previous one and IoT SiteWise will generate a new unique `id`.
5734
5875
  #
5735
5876
  #
5736
5877
  #
5737
5878
  # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/update-assets-and-models.html
5738
- # [2]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAssetModel.html
5739
5879
  #
5740
5880
  # @option params [required, String] :asset_model_id
5741
5881
  # The ID of the asset model to update. This can be either the actual ID
@@ -5747,8 +5887,18 @@ module Aws::IoTSiteWise
5747
5887
  #
5748
5888
  # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references
5749
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
+ #
5750
5900
  # @option params [required, String] :asset_model_name
5751
- # A unique, friendly name for the asset model.
5901
+ # A unique name for the asset model.
5752
5902
  #
5753
5903
  # @option params [String] :asset_model_description
5754
5904
  # A description for the asset model.
@@ -5790,13 +5940,15 @@ module Aws::IoTSiteWise
5790
5940
  #
5791
5941
  # <note markdown="1"> When creating custom composite models, you need to use
5792
5942
  # [CreateAssetModelCompositeModel][1]. For more information, see
5793
- # &lt;LINK&gt;.
5943
+ # [Creating custom composite models (Components)][2] in the *IoT
5944
+ # SiteWise User Guide*.
5794
5945
  #
5795
5946
  # </note>
5796
5947
  #
5797
5948
  #
5798
5949
  #
5799
5950
  # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModelCompositeModel.html
5951
+ # [2]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-custom-composite-models.html
5800
5952
  #
5801
5953
  # @option params [String] :client_token
5802
5954
  # A unique case-sensitive identifier that you can provide to ensure the
@@ -5806,15 +5958,26 @@ module Aws::IoTSiteWise
5806
5958
  # **A suitable default value is auto-generated.** You should normally
5807
5959
  # not need to pass this option.**
5808
5960
  #
5809
- # @option params [String] :asset_model_external_id
5810
- # An external ID to assign to the asset model. The asset model must not
5811
- # already have an external ID. The external ID must be unique within
5812
- # your Amazon Web Services account. For more information, see [Using
5813
- # external IDs][1] in the *IoT SiteWise User Guide*.
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*.
5814
5967
  #
5815
5968
  #
5816
5969
  #
5817
- # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
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.
5818
5981
  #
5819
5982
  # @return [Types::UpdateAssetModelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5820
5983
  #
@@ -5824,11 +5987,13 @@ module Aws::IoTSiteWise
5824
5987
  #
5825
5988
  # resp = client.update_asset_model({
5826
5989
  # asset_model_id: "CustomID", # required
5990
+ # asset_model_external_id: "ExternalId",
5827
5991
  # asset_model_name: "Name", # required
5828
5992
  # asset_model_description: "Description",
5829
5993
  # asset_model_properties: [
5830
5994
  # {
5831
5995
  # id: "CustomID",
5996
+ # external_id: "ExternalId",
5832
5997
  # name: "Name", # required
5833
5998
  # data_type: "STRING", # required, accepts STRING, INTEGER, DOUBLE, BOOLEAN, STRUCT
5834
5999
  # data_type_spec: "Name",
@@ -5902,15 +6067,14 @@ module Aws::IoTSiteWise
5902
6067
  # name: "Name",
5903
6068
  # },
5904
6069
  # ],
5905
- # external_id: "ExternalId",
5906
6070
  # },
5907
6071
  # ],
5908
6072
  # asset_model_hierarchies: [
5909
6073
  # {
5910
6074
  # id: "CustomID",
6075
+ # external_id: "ExternalId",
5911
6076
  # name: "Name", # required
5912
6077
  # child_asset_model_id: "CustomID", # required
5913
- # external_id: "ExternalId",
5914
6078
  # },
5915
6079
  # ],
5916
6080
  # asset_model_composite_models: [
@@ -5921,6 +6085,7 @@ module Aws::IoTSiteWise
5921
6085
  # properties: [
5922
6086
  # {
5923
6087
  # id: "CustomID",
6088
+ # external_id: "ExternalId",
5924
6089
  # name: "Name", # required
5925
6090
  # data_type: "STRING", # required, accepts STRING, INTEGER, DOUBLE, BOOLEAN, STRUCT
5926
6091
  # data_type_spec: "Name",
@@ -5994,7 +6159,6 @@ module Aws::IoTSiteWise
5994
6159
  # name: "Name",
5995
6160
  # },
5996
6161
  # ],
5997
- # external_id: "ExternalId",
5998
6162
  # },
5999
6163
  # ],
6000
6164
  # id: "CustomID",
@@ -6002,7 +6166,9 @@ module Aws::IoTSiteWise
6002
6166
  # },
6003
6167
  # ],
6004
6168
  # client_token: "ClientToken",
6005
- # asset_model_external_id: "ExternalId",
6169
+ # if_match: "ETag",
6170
+ # if_none_match: "SelectAll",
6171
+ # match_for_version_type: "LATEST", # accepts LATEST, ACTIVE
6006
6172
  # })
6007
6173
  #
6008
6174
  # @example Response structure
@@ -6062,7 +6228,7 @@ module Aws::IoTSiteWise
6062
6228
  # A description for the composite model.
6063
6229
  #
6064
6230
  # @option params [required, String] :asset_model_composite_model_name
6065
- # A unique, friendly name for the composite model.
6231
+ # A unique name for the composite model.
6066
6232
  #
6067
6233
  # @option params [String] :client_token
6068
6234
  # A unique case-sensitive identifier that you can provide to ensure the
@@ -6074,14 +6240,37 @@ module Aws::IoTSiteWise
6074
6240
  #
6075
6241
  # @option params [Array<Types::AssetModelProperty>] :asset_model_composite_model_properties
6076
6242
  # The property definitions of the composite model. For more information,
6077
- # see &lt;LINK&gt;.
6243
+ # see [ Inline custom composite models][1] in the *IoT SiteWise User
6244
+ # Guide*.
6078
6245
  #
6079
6246
  # You can specify up to 200 properties per composite model. For more
6080
- # information, see [Quotas][1] in the *IoT SiteWise User Guide*.
6247
+ # information, see [Quotas][2] in the *IoT SiteWise User Guide*.
6248
+ #
6249
+ #
6250
+ #
6251
+ # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/custom-composite-models.html#inline-composite-models
6252
+ # [2]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html
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
+ #
6081
6261
  #
6082
6262
  #
6263
+ # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/opt-locking-for-model.html
6083
6264
  #
6084
- # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html
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.
6085
6274
  #
6086
6275
  # @return [Types::UpdateAssetModelCompositeModelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
6087
6276
  #
@@ -6100,6 +6289,7 @@ module Aws::IoTSiteWise
6100
6289
  # asset_model_composite_model_properties: [
6101
6290
  # {
6102
6291
  # id: "CustomID",
6292
+ # external_id: "ExternalId",
6103
6293
  # name: "Name", # required
6104
6294
  # data_type: "STRING", # required, accepts STRING, INTEGER, DOUBLE, BOOLEAN, STRUCT
6105
6295
  # data_type_spec: "Name",
@@ -6173,9 +6363,11 @@ module Aws::IoTSiteWise
6173
6363
  # name: "Name",
6174
6364
  # },
6175
6365
  # ],
6176
- # external_id: "ExternalId",
6177
6366
  # },
6178
6367
  # ],
6368
+ # if_match: "ETag",
6369
+ # if_none_match: "SelectAll",
6370
+ # match_for_version_type: "LATEST", # accepts LATEST, ACTIVE
6179
6371
  # })
6180
6372
  #
6181
6373
  # @example Response structure
@@ -6342,7 +6534,7 @@ module Aws::IoTSiteWise
6342
6534
  # The ID of the gateway to update.
6343
6535
  #
6344
6536
  # @option params [required, String] :gateway_name
6345
- # A unique, friendly name for the gateway.
6537
+ # A unique name for the gateway.
6346
6538
  #
6347
6539
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
6348
6540
  #
@@ -6350,7 +6542,7 @@ module Aws::IoTSiteWise
6350
6542
  #
6351
6543
  # resp = client.update_gateway({
6352
6544
  # gateway_id: "ID", # required
6353
- # gateway_name: "Name", # required
6545
+ # gateway_name: "GatewayName", # required
6354
6546
  # })
6355
6547
  #
6356
6548
  # @overload update_gateway(params = {})
@@ -6407,7 +6599,7 @@ module Aws::IoTSiteWise
6407
6599
  # @example Response structure
6408
6600
  #
6409
6601
  # resp.capability_namespace #=> String
6410
- # resp.capability_sync_status #=> String, one of "IN_SYNC", "OUT_OF_SYNC", "SYNC_FAILED", "UNKNOWN"
6602
+ # resp.capability_sync_status #=> String, one of "IN_SYNC", "OUT_OF_SYNC", "SYNC_FAILED", "UNKNOWN", "NOT_APPLICABLE"
6411
6603
  #
6412
6604
  # @overload update_gateway_capability_configuration(params = {})
6413
6605
  # @param [Hash] params ({})
@@ -6561,7 +6753,7 @@ module Aws::IoTSiteWise
6561
6753
  params: params,
6562
6754
  config: config)
6563
6755
  context[:gem_name] = 'aws-sdk-iotsitewise'
6564
- context[:gem_version] = '1.67.0'
6756
+ context[:gem_version] = '1.69.0'
6565
6757
  Seahorse::Client::Request.new(handlers, context)
6566
6758
  end
6567
6759