Skip to content

Commit 741ca0c

Browse files
author
AWS
committed
AWS IoT SiteWise Update: Adds support for creating SiteWise Edge gateways that run on a Siemens Industrial Edge Device.
1 parent af1f673 commit 741ca0c

File tree

2 files changed

+65
-27
lines changed

2 files changed

+65
-27
lines changed

‎.changes/next-release/feature-AWSIoTSiteWise-85dc5b9.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"type": "feature",
3+
"category": "AWS IoT SiteWise",
4+
"contributor": "",
5+
"description": "Adds support for creating SiteWise Edge gateways that run on a Siemens Industrial Edge Device."
6+
}

‎services/iotsitewise/src/main/resources/codegen-resources/service-2.json

Lines changed: 59 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,13 @@
55
"endpointPrefix":"iotsitewise",
66
"jsonVersion":"1.1",
77
"protocol":"rest-json",
8+
"protocols":["rest-json"],
89
"serviceFullName":"AWS IoT SiteWise",
910
"serviceId":"IoTSiteWise",
1011
"signatureVersion":"v4",
1112
"signingName":"iotsitewise",
12-
"uid":"iotsitewise-2019-12-02"
13+
"uid":"iotsitewise-2019-12-02",
14+
"auth":["aws.auth#sigv4"]
1315
},
1416
"operations":{
1517
"AssociateAssets":{
@@ -438,6 +440,7 @@
438440
"errors":[
439441
{"shape":"InvalidRequestException"},
440442
{"shape":"ResourceNotFoundException"},
443+
{"shape":"ConflictingOperationException"},
441444
{"shape":"InternalFailureException"},
442445
{"shape":"ThrottlingException"}
443446
],
@@ -1398,7 +1401,7 @@
13981401
{"shape":"ThrottlingException"},
13991402
{"shape":"ConflictingOperationException"}
14001403
],
1401-
"documentation":"<p>Updates an asset model and all of the assets that were created from the model. Each asset created from the model inherits the updated asset model's property and hierarchy definitions. For more information, see <a href=\"https://docs.aws.amazon.com/iot-sitewise/latest/userguide/update-assets-and-models.html\">Updating assets and models</a> in the <i>IoT SiteWise User Guide</i>.</p> <important> <p>This operation overwrites the existing model with the provided model. To avoid deleting your asset model's properties or hierarchies, you must include their IDs and definitions in the updated asset model payload. For more information, see <a href=\"https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAssetModel.html\">DescribeAssetModel</a>.</p> <p>If you remove a property from an asset model, IoT SiteWise deletes all previous data for that property. If you remove a hierarchy definition from an asset model, IoT SiteWise disassociates every asset associated with that hierarchy. You can't change the type or data type of an existing property.</p> </important>",
1404+
"documentation":"<p>Updates an asset model and all of the assets that were created from the model. Each asset created from the model inherits the updated asset model's property and hierarchy definitions. For more information, see <a href=\"https://docs.aws.amazon.com/iot-sitewise/latest/userguide/update-assets-and-models.html\">Updating assets and models</a> in the <i>IoT SiteWise User Guide</i>.</p> <important> <p>If you remove a property from an asset model, IoT SiteWise deletes all previous data for that property. You can’t change the type or data type of an existing property.</p> <p>To replace an existing asset model property with a new one with the same <code>name</code>, do the following:</p> <ol> <li> <p>Submit an <code>UpdateAssetModel</code> request with the entire existing property removed.</p> </li> <li> <p>Submit a second <code>UpdateAssetModel</code> request that includes the new property. The new asset property will have the same <code>name</code> as the previous one and IoT SiteWise will generate a new unique <code>id</code>.</p> </li> </ol> </important>",
14021405
"endpoint":{"hostPrefix":"api."}
14031406
},
14041407
"UpdateAssetModelCompositeModel":{
@@ -2017,23 +2020,23 @@
20172020
"members":{
20182021
"id":{
20192022
"shape":"ID",
2020-
"documentation":"<p>The ID of the the composite model that this summary describes..</p>"
2023+
"documentation":"<p>The ID of the composite model that this summary describes..</p>"
20212024
},
20222025
"externalId":{
20232026
"shape":"ExternalId",
20242027
"documentation":"<p>The external ID of a composite model on this asset model. For more information, see <a href=\"https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids\">Using external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>"
20252028
},
20262029
"name":{
20272030
"shape":"Name",
2028-
"documentation":"<p>The name of the the composite model that this summary describes..</p>"
2031+
"documentation":"<p>The name of the composite model that this summary describes..</p>"
20292032
},
20302033
"type":{
20312034
"shape":"Name",
2032-
"documentation":"<p>The type of asset model.</p> <ul> <li> <p> <b>ASSET_MODEL</b> – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model.</p> </li> <li> <p> <b>COMPONENT_MODEL</b> – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model. </p> </li> </ul>"
2035+
"documentation":"<p>The composite model type. Valid values are <code>AWS/ALARM</code>, <code>CUSTOM</code>, or <code> AWS/L4E_ANOMALY</code>.</p>"
20332036
},
20342037
"description":{
20352038
"shape":"Description",
2036-
"documentation":"<p>The description of the the composite model that this summary describes..</p>"
2039+
"documentation":"<p>The description of the composite model that this summary describes..</p>"
20372040
},
20382041
"path":{
20392042
"shape":"AssetModelCompositeModelPath",
@@ -3469,7 +3472,7 @@
34693472
},
34703473
"CapabilityConfiguration":{
34713474
"type":"string",
3472-
"max":104857600,
3475+
"max":10000000,
34733476
"min":1
34743477
},
34753478
"CapabilityNamespace":{
@@ -3484,7 +3487,8 @@
34843487
"IN_SYNC",
34853488
"OUT_OF_SYNC",
34863489
"SYNC_FAILED",
3487-
"UNKNOWN"
3490+
"UNKNOWN",
3491+
"NOT_APPLICABLE"
34883492
]
34893493
},
34903494
"ClientToken":{
@@ -3690,7 +3694,8 @@
36903694
"CoreDeviceThingName":{
36913695
"type":"string",
36923696
"max":128,
3693-
"min":1
3697+
"min":1,
3698+
"pattern":"^[a-zA-Z0-9:_-]+$"
36943699
},
36953700
"CreateAccessPolicyRequest":{
36963701
"type":"structure",
@@ -3772,7 +3777,7 @@
37723777
},
37733778
"assetModelCompositeModelName":{
37743779
"shape":"Name",
3775-
"documentation":"<p>A unique, friendly name for the composite model.</p>"
3780+
"documentation":"<p>A unique name for the composite model.</p>"
37763781
},
37773782
"assetModelCompositeModelType":{
37783783
"shape":"Name",
@@ -3785,11 +3790,11 @@
37853790
},
37863791
"composedAssetModelId":{
37873792
"shape":"CustomID",
3788-
"documentation":"<p>The ID of a composite model on this asset.</p>"
3793+
"documentation":"<p>The ID of a component model which is reused to create this composite model.</p>"
37893794
},
37903795
"assetModelCompositeModelProperties":{
37913796
"shape":"AssetModelPropertyDefinitions",
3792-
"documentation":"<p>The property definitions of the composite model. For more information, see &lt;LINK&gt;.</p> <p>You can specify up to 200 properties per composite model. For more information, see <a href=\"https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html\">Quotas</a> in the <i>IoT SiteWise User Guide</i>.</p>"
3797+
"documentation":"<p>The property definitions of the composite model. For more information, see <a href=\"https://docs.aws.amazon.com/iot-sitewise/latest/userguide/custom-composite-models.html#inline-composite-models\"> Inline custom composite models</a> in the <i>IoT SiteWise User Guide</i>.</p> <p>You can specify up to 200 properties per composite model. For more information, see <a href=\"https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html\">Quotas</a> in the <i>IoT SiteWise User Guide</i>.</p>"
37933798
}
37943799
}
37953800
},
@@ -3818,7 +3823,7 @@
38183823
"members":{
38193824
"assetModelName":{
38203825
"shape":"Name",
3821-
"documentation":"<p>A unique, friendly name for the asset model.</p>"
3826+
"documentation":"<p>A unique name for the asset model.</p>"
38223827
},
38233828
"assetModelDescription":{
38243829
"shape":"Description",
@@ -3834,7 +3839,7 @@
38343839
},
38353840
"assetModelCompositeModels":{
38363841
"shape":"AssetModelCompositeModelDefinitions",
3837-
"documentation":"<p>The composite models that are part of this asset model. It groups properties (such as attributes, measurements, transforms, and metrics) and child composite models that model parts of your industrial equipment. Each composite model has a type that defines the properties that the composite model supports. Use composite models to define alarms on this asset model.</p> <note> <p>When creating custom composite models, you need to use <a href=\"https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModelCompositeModel.html\">CreateAssetModelCompositeModel</a>. For more information, see &lt;LINK&gt;.</p> </note>"
3842+
"documentation":"<p>The composite models that are part of this asset model. It groups properties (such as attributes, measurements, transforms, and metrics) and child composite models that model parts of your industrial equipment. Each composite model has a type that defines the properties that the composite model supports. Use composite models to define alarms on this asset model.</p> <note> <p>When creating custom composite models, you need to use <a href=\"https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModelCompositeModel.html\">CreateAssetModelCompositeModel</a>. For more information, see <a href=\"https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-custom-composite-models.html\">Creating custom composite models (Components)</a> in the <i>IoT SiteWise User Guide</i>.</p> </note>"
38383843
},
38393844
"clientToken":{
38403845
"shape":"ClientToken",
@@ -4063,8 +4068,8 @@
40634068
],
40644069
"members":{
40654070
"gatewayName":{
4066-
"shape":"Name",
4067-
"documentation":"<p>A unique, friendly name for the gateway.</p>"
4071+
"shape":"GatewayName",
4072+
"documentation":"<p>A unique name for the gateway.</p>"
40684073
},
40694074
"gatewayPlatform":{
40704075
"shape":"GatewayPlatform",
@@ -5276,7 +5281,7 @@
52765281
"documentation":"<p>The ID of the gateway device.</p>"
52775282
},
52785283
"gatewayName":{
5279-
"shape":"Name",
5284+
"shape":"GatewayName",
52805285
"documentation":"<p>The name of the gateway.</p>"
52815286
},
52825287
"gatewayArn":{
@@ -5938,6 +5943,12 @@
59385943
},
59395944
"documentation":"<p>Contains a summary of a gateway capability configuration.</p>"
59405945
},
5946+
"GatewayName":{
5947+
"type":"string",
5948+
"max":256,
5949+
"min":1,
5950+
"pattern":"[^\\u0000-\\u001F\\u007F]+"
5951+
},
59415952
"GatewayPlatform":{
59425953
"type":"structure",
59435954
"members":{
@@ -5948,6 +5959,10 @@
59485959
"greengrassV2":{
59495960
"shape":"GreengrassV2",
59505961
"documentation":"<p>A gateway that runs on IoT Greengrass V2.</p>"
5962+
},
5963+
"siemensIE":{
5964+
"shape":"SiemensIE",
5965+
"documentation":"<p>A SiteWise Edge gateway that runs on a Siemens Industrial Edge Device.</p>"
59515966
}
59525967
},
59535968
"documentation":"<p>Contains a gateway's platform information.</p>"
@@ -5970,8 +5985,8 @@
59705985
"documentation":"<p>The ID of the gateway device.</p>"
59715986
},
59725987
"gatewayName":{
5973-
"shape":"Name",
5974-
"documentation":"<p>The name of the asset.</p>"
5988+
"shape":"GatewayName",
5989+
"documentation":"<p>The name of the gateway.</p>"
59755990
},
59765991
"gatewayPlatform":{"shape":"GatewayPlatform"},
59775992
"gatewayCapabilitySummaries":{
@@ -6303,7 +6318,7 @@
63036318
"members":{
63046319
"groupArn":{
63056320
"shape":"ARN",
6306-
"documentation":"<p>The <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">ARN</a> of the Greengrass group. For more information about how to find a group's ARN, see <a href=\"https://docs.aws.amazon.com/greengrass/latest/apireference/listgroups-get.html\">ListGroups</a> and <a href=\"https://docs.aws.amazon.com/greengrass/latest/apireference/getgroup-get.html\">GetGroup</a> in the <i>IoT Greengrass API Reference</i>.</p>"
6321+
"documentation":"<p>The <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">ARN</a> of the Greengrass group. For more information about how to find a group's ARN, see <a href=\"https://docs.aws.amazon.com/greengrass/v1/apireference/listgroups-get.html\">ListGroups</a> and <a href=\"https://docs.aws.amazon.com/greengrass/v1/apireference/getgroup-get.html\">GetGroup</a> in the <i>IoT Greengrass V1 API Reference</i>.</p>"
63076322
}
63086323
},
63096324
"documentation":"<p>Contains details for a gateway that runs on IoT Greengrass. To create a gateway that runs on IoT Greengrass, you must add the IoT SiteWise connector to a Greengrass group and deploy it. Your Greengrass group must also have permissions to upload data to IoT SiteWise. For more information, see <a href=\"https://docs.aws.amazon.com/iot-sitewise/latest/userguide/gateway-connector.html\">Ingesting data using a gateway</a> in the <i>IoT SiteWise User Guide</i>.</p>"
@@ -6513,6 +6528,12 @@
65136528
"error":{"httpStatusCode":400},
65146529
"exception":true
65156530
},
6531+
"IotCoreThingName":{
6532+
"type":"string",
6533+
"max":128,
6534+
"min":1,
6535+
"pattern":"^[a-zA-Z0-9:_-]+$"
6536+
},
65166537
"JobConfiguration":{
65176538
"type":"structure",
65186539
"required":["fileFormat"],
@@ -8075,6 +8096,17 @@
80758096
"exception":true,
80768097
"fault":true
80778098
},
8099+
"SiemensIE":{
8100+
"type":"structure",
8101+
"required":["iotCoreThingName"],
8102+
"members":{
8103+
"iotCoreThingName":{
8104+
"shape":"IotCoreThingName",
8105+
"documentation":"<p>The name of the IoT Thing for your SiteWise Edge gateway.</p>"
8106+
}
8107+
},
8108+
"documentation":"<p>Contains details for a SiteWise Edge gateway that runs on a Siemens Industrial Edge Device.</p>"
8109+
},
80788110
"StorageType":{
80798111
"type":"string",
80808112
"enum":[
@@ -8424,7 +8456,7 @@
84248456
},
84258457
"assetModelCompositeModelName":{
84268458
"shape":"Name",
8427-
"documentation":"<p>A unique, friendly name for the composite model.</p>"
8459+
"documentation":"<p>A unique name for the composite model.</p>"
84288460
},
84298461
"clientToken":{
84308462
"shape":"ClientToken",
@@ -8433,7 +8465,7 @@
84338465
},
84348466
"assetModelCompositeModelProperties":{
84358467
"shape":"AssetModelProperties",
8436-
"documentation":"<p>The property definitions of the composite model. For more information, see &lt;LINK&gt;.</p> <p>You can specify up to 200 properties per composite model. For more information, see <a href=\"https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html\">Quotas</a> in the <i>IoT SiteWise User Guide</i>.</p>"
8468+
"documentation":"<p>The property definitions of the composite model. For more information, see <a href=\"https://docs.aws.amazon.com/iot-sitewise/latest/userguide/custom-composite-models.html#inline-composite-models\"> Inline custom composite models</a> in the <i>IoT SiteWise User Guide</i>.</p> <p>You can specify up to 200 properties per composite model. For more information, see <a href=\"https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html\">Quotas</a> in the <i>IoT SiteWise User Guide</i>.</p>"
84378469
}
84388470
}
84398471
},
@@ -8466,7 +8498,7 @@
84668498
},
84678499
"assetModelName":{
84688500
"shape":"Name",
8469-
"documentation":"<p>A unique, friendly name for the asset model.</p>"
8501+
"documentation":"<p>A unique name for the asset model.</p>"
84708502
},
84718503
"assetModelDescription":{
84728504
"shape":"Description",
@@ -8482,7 +8514,7 @@
84828514
},
84838515
"assetModelCompositeModels":{
84848516
"shape":"AssetModelCompositeModels",
8485-
"documentation":"<p>The composite models that are part of this asset model. It groups properties (such as attributes, measurements, transforms, and metrics) and child composite models that model parts of your industrial equipment. Each composite model has a type that defines the properties that the composite model supports. Use composite models to define alarms on this asset model.</p> <note> <p>When creating custom composite models, you need to use <a href=\"https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModelCompositeModel.html\">CreateAssetModelCompositeModel</a>. For more information, see &lt;LINK&gt;.</p> </note>"
8517+
"documentation":"<p>The composite models that are part of this asset model. It groups properties (such as attributes, measurements, transforms, and metrics) and child composite models that model parts of your industrial equipment. Each composite model has a type that defines the properties that the composite model supports. Use composite models to define alarms on this asset model.</p> <note> <p>When creating custom composite models, you need to use <a href=\"https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModelCompositeModel.html\">CreateAssetModelCompositeModel</a>. For more information, see <a href=\"https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-custom-composite-models.html\">Creating custom composite models (Components)</a> in the <i>IoT SiteWise User Guide</i>.</p> </note>"
84868518
},
84878519
"clientToken":{
84888520
"shape":"ClientToken",
@@ -8678,8 +8710,8 @@
86788710
"locationName":"gatewayId"
86798711
},
86808712
"gatewayName":{
8681-
"shape":"Name",
8682-
"documentation":"<p>A unique, friendly name for the gateway.</p>"
8713+
"shape":"GatewayName",
8714+
"documentation":"<p>A unique name for the gateway.</p>"
86838715
}
86848716
}
86858717
},
@@ -8832,7 +8864,7 @@
88328864
},
88338865
"integerValue":{
88348866
"shape":"PropertyValueIntegerValue",
8835-
"documentation":"<p>Asset property data of type integer (number that's greater than or equal to zero).</p>"
8867+
"documentation":"<p>Asset property data of type integer (whole number).</p>"
88368868
},
88378869
"doubleValue":{
88388870
"shape":"PropertyValueDoubleValue",

0 commit comments

Comments
 (0)