Skip to content

Commit 1a44ab1

Browse files
author
AWS
committed
AWS IoT SiteWise Update: Update the default endpoint for the APIs used to manage asset models, assets, gateways, tags, and account configurations. If you have firewalls with strict egress rules, configure the rules to grant you access to api.iotsitewise.[region].amazonaws.com or api.iotsitewise.[cn-region].amazonaws.com.cn.
1 parent 726ad1a commit 1a44ab1

File tree

2 files changed

+45
-32
lines changed

2 files changed

+45
-32
lines changed

‎.changes/next-release/feature-AWSIoTSiteWise-04cbf32.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": "Update the default endpoint for the APIs used to manage asset models, assets, gateways, tags, and account configurations. If you have firewalls with strict egress rules, configure the rules to grant you access to api.iotsitewise.[region].amazonaws.com or api.iotsitewise.[cn-region].amazonaws.com.cn."
6+
}

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

Lines changed: 39 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
{"shape":"ConflictingOperationException"}
2929
],
3030
"documentation":"<p>Associates a child asset with the given parent asset through a hierarchy defined in the parent asset's model. For more information, see <a href=\"https://docs.aws.amazon.com/iot-sitewise/latest/userguide/add-associated-assets.html\">Associating assets</a> in the <i>IoT SiteWise User Guide</i>.</p>",
31-
"endpoint":{"hostPrefix":"model."}
31+
"endpoint":{"hostPrefix":"api."}
3232
},
3333
"BatchAssociateProjectAssets":{
3434
"name":"BatchAssociateProjectAssets",
@@ -125,7 +125,7 @@
125125
{"shape":"ConflictingOperationException"}
126126
],
127127
"documentation":"<p>Creates an asset from an existing asset model. For more information, see <a href=\"https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-assets.html\">Creating assets</a> in the <i>IoT SiteWise User Guide</i>.</p>",
128-
"endpoint":{"hostPrefix":"model."}
128+
"endpoint":{"hostPrefix":"api."}
129129
},
130130
"CreateAssetModel":{
131131
"name":"CreateAssetModel",
@@ -146,7 +146,7 @@
146146
{"shape":"ConflictingOperationException"}
147147
],
148148
"documentation":"<p>Creates an asset model from specified property and hierarchy definitions. You create assets from asset models. With asset models, you can easily create assets of the same type that have standardized definitions. Each asset created from a model inherits the asset model's property and hierarchy definitions. For more information, see <a href=\"https://docs.aws.amazon.com/iot-sitewise/latest/userguide/define-models.html\">Defining asset models</a> in the <i>IoT SiteWise User Guide</i>.</p>",
149-
"endpoint":{"hostPrefix":"model."}
149+
"endpoint":{"hostPrefix":"api."}
150150
},
151151
"CreateDashboard":{
152152
"name":"CreateDashboard",
@@ -184,7 +184,7 @@
184184
{"shape":"LimitExceededException"}
185185
],
186186
"documentation":"<p>Creates a gateway, which is a virtual or edge device that delivers industrial data streams from local servers 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>",
187-
"endpoint":{"hostPrefix":"edge."}
187+
"endpoint":{"hostPrefix":"api."}
188188
},
189189
"CreatePortal":{
190190
"name":"CreatePortal",
@@ -259,7 +259,7 @@
259259
{"shape":"ConflictingOperationException"}
260260
],
261261
"documentation":"<p>Deletes an asset. This action can't be undone. For more information, see <a href=\"https://docs.aws.amazon.com/iot-sitewise/latest/userguide/delete-assets-and-models.html\">Deleting assets and models</a> in the <i>IoT SiteWise User Guide</i>. </p> <note> <p>You can't delete an asset that's associated to another asset. For more information, see <a href=\"https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DisassociateAssets.html\">DisassociateAssets</a>.</p> </note>",
262-
"endpoint":{"hostPrefix":"model."}
262+
"endpoint":{"hostPrefix":"api."}
263263
},
264264
"DeleteAssetModel":{
265265
"name":"DeleteAssetModel",
@@ -278,7 +278,7 @@
278278
{"shape":"ConflictingOperationException"}
279279
],
280280
"documentation":"<p>Deletes an asset model. This action can't be undone. You must delete all assets created from an asset model before you can delete the model. Also, you can't delete an asset model if a parent asset model exists that contains a property formula expression that depends on the asset model that you want to delete. For more information, see <a href=\"https://docs.aws.amazon.com/iot-sitewise/latest/userguide/delete-assets-and-models.html\">Deleting assets and models</a> in the <i>IoT SiteWise User Guide</i>.</p>",
281-
"endpoint":{"hostPrefix":"model."}
281+
"endpoint":{"hostPrefix":"api."}
282282
},
283283
"DeleteDashboard":{
284284
"name":"DeleteDashboard",
@@ -312,7 +312,7 @@
312312
{"shape":"ThrottlingException"}
313313
],
314314
"documentation":"<p>Deletes a gateway from IoT SiteWise. When you delete a gateway, some of the gateway's files remain in your gateway's file system.</p>",
315-
"endpoint":{"hostPrefix":"edge."}
315+
"endpoint":{"hostPrefix":"api."}
316316
},
317317
"DeletePortal":{
318318
"name":"DeletePortal",
@@ -384,7 +384,7 @@
384384
{"shape":"ThrottlingException"}
385385
],
386386
"documentation":"<p>Retrieves information about an asset.</p>",
387-
"endpoint":{"hostPrefix":"model."}
387+
"endpoint":{"hostPrefix":"api."}
388388
},
389389
"DescribeAssetModel":{
390390
"name":"DescribeAssetModel",
@@ -401,7 +401,7 @@
401401
{"shape":"ThrottlingException"}
402402
],
403403
"documentation":"<p>Retrieves information about an asset model.</p>",
404-
"endpoint":{"hostPrefix":"model."}
404+
"endpoint":{"hostPrefix":"api."}
405405
},
406406
"DescribeAssetProperty":{
407407
"name":"DescribeAssetProperty",
@@ -418,7 +418,7 @@
418418
{"shape":"ThrottlingException"}
419419
],
420420
"documentation":"<p>Retrieves information about an asset property.</p> <note> <p>When you call this operation for an attribute property, this response includes the default attribute value that you define in the asset model. If you update the default value in the model, this operation's response includes the new default value.</p> </note> <p>This operation doesn't return the value of the asset property. To get the value of an asset property, use <a href=\"https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_GetAssetPropertyValue.html\">GetAssetPropertyValue</a>.</p>",
421-
"endpoint":{"hostPrefix":"model."}
421+
"endpoint":{"hostPrefix":"api."}
422422
},
423423
"DescribeDashboard":{
424424
"name":"DescribeDashboard",
@@ -451,7 +451,8 @@
451451
{"shape":"InternalFailureException"},
452452
{"shape":"ThrottlingException"}
453453
],
454-
"documentation":"<p>Retrieves information about the default encryption configuration for the Amazon Web Services account in the default or specified Region. For more information, see <a href=\"https://docs.aws.amazon.com/iot-sitewise/latest/userguide/key-management.html\">Key management</a> in the <i>IoT SiteWise User Guide</i>.</p>"
454+
"documentation":"<p>Retrieves information about the default encryption configuration for the Amazon Web Services account in the default or specified Region. For more information, see <a href=\"https://docs.aws.amazon.com/iot-sitewise/latest/userguide/key-management.html\">Key management</a> in the <i>IoT SiteWise User Guide</i>.</p>",
455+
"endpoint":{"hostPrefix":"api."}
455456
},
456457
"DescribeGateway":{
457458
"name":"DescribeGateway",
@@ -468,7 +469,7 @@
468469
{"shape":"ThrottlingException"}
469470
],
470471
"documentation":"<p>Retrieves information about a gateway.</p>",
471-
"endpoint":{"hostPrefix":"edge."}
472+
"endpoint":{"hostPrefix":"api."}
472473
},
473474
"DescribeGatewayCapabilityConfiguration":{
474475
"name":"DescribeGatewayCapabilityConfiguration",
@@ -485,7 +486,7 @@
485486
{"shape":"ThrottlingException"}
486487
],
487488
"documentation":"<p>Retrieves information about a gateway capability configuration. Each gateway capability defines data sources for a gateway. A capability configuration can contain multiple data source configurations. If you define OPC-UA sources for a gateway in the IoT SiteWise console, all of your OPC-UA sources are stored in one capability configuration. To list all capability configurations for a gateway, use <a href=\"https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeGateway.html\">DescribeGateway</a>.</p>",
488-
"endpoint":{"hostPrefix":"edge."}
489+
"endpoint":{"hostPrefix":"api."}
489490
},
490491
"DescribeLoggingOptions":{
491492
"name":"DescribeLoggingOptions",
@@ -502,7 +503,7 @@
502503
{"shape":"ResourceNotFoundException"}
503504
],
504505
"documentation":"<p>Retrieves the current IoT SiteWise logging options.</p>",
505-
"endpoint":{"hostPrefix":"model."}
506+
"endpoint":{"hostPrefix":"api."}
506507
},
507508
"DescribePortal":{
508509
"name":"DescribePortal",
@@ -556,7 +557,8 @@
556557
{"shape":"LimitExceededException"},
557558
{"shape":"ConflictingOperationException"}
558559
],
559-
"documentation":"<p>Retrieves information about the storage configuration for IoT SiteWise.</p>"
560+
"documentation":"<p>Retrieves information about the storage configuration for IoT SiteWise.</p>",
561+
"endpoint":{"hostPrefix":"api."}
560562
},
561563
"DisassociateAssets":{
562564
"name":"DisassociateAssets",
@@ -573,7 +575,7 @@
573575
{"shape":"ConflictingOperationException"}
574576
],
575577
"documentation":"<p>Disassociates a child asset from the given parent asset through a hierarchy defined in the parent asset's model.</p>",
576-
"endpoint":{"hostPrefix":"model."}
578+
"endpoint":{"hostPrefix":"api."}
577579
},
578580
"GetAssetPropertyAggregates":{
579581
"name":"GetAssetPropertyAggregates",
@@ -678,7 +680,7 @@
678680
{"shape":"ThrottlingException"}
679681
],
680682
"documentation":"<p>Retrieves a paginated list of summaries of all asset models.</p>",
681-
"endpoint":{"hostPrefix":"model."}
683+
"endpoint":{"hostPrefix":"api."}
682684
},
683685
"ListAssetRelationships":{
684686
"name":"ListAssetRelationships",
@@ -695,7 +697,7 @@
695697
{"shape":"ThrottlingException"}
696698
],
697699
"documentation":"<p>Retrieves a paginated list of asset relationships for an asset. You can use this operation to identify an asset's root asset and all associated assets between that asset and its root.</p>",
698-
"endpoint":{"hostPrefix":"model."}
700+
"endpoint":{"hostPrefix":"api."}
699701
},
700702
"ListAssets":{
701703
"name":"ListAssets",
@@ -712,7 +714,7 @@
712714
{"shape":"ThrottlingException"}
713715
],
714716
"documentation":"<p>Retrieves a paginated list of asset summaries.</p> <p>You can use this operation to do the following:</p> <ul> <li> <p>List assets based on a specific asset model.</p> </li> <li> <p>List top-level assets.</p> </li> </ul> <p>You can't use this operation to list all assets. To retrieve summaries for all of your assets, use <a href=\"https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_ListAssetModels.html\">ListAssetModels</a> to get all of your asset model IDs. Then, use ListAssets to get all assets for each asset model.</p>",
715-
"endpoint":{"hostPrefix":"model."}
717+
"endpoint":{"hostPrefix":"api."}
716718
},
717719
"ListAssociatedAssets":{
718720
"name":"ListAssociatedAssets",
@@ -729,7 +731,7 @@
729731
{"shape":"ThrottlingException"}
730732
],
731733
"documentation":"<p>Retrieves a paginated list of associated assets.</p> <p>You can use this operation to do the following:</p> <ul> <li> <p>List child assets associated to a parent asset by a hierarchy that you specify.</p> </li> <li> <p>List an asset's parent asset.</p> </li> </ul>",
732-
"endpoint":{"hostPrefix":"model."}
734+
"endpoint":{"hostPrefix":"api."}
733735
},
734736
"ListDashboards":{
735737
"name":"ListDashboards",
@@ -762,7 +764,7 @@
762764
{"shape":"ThrottlingException"}
763765
],
764766
"documentation":"<p>Retrieves a paginated list of gateways.</p>",
765-
"endpoint":{"hostPrefix":"edge."}
767+
"endpoint":{"hostPrefix":"api."}
766768
},
767769
"ListPortals":{
768770
"name":"ListPortals",
@@ -832,7 +834,8 @@
832834
{"shape":"LimitExceededException"},
833835
{"shape":"UnauthorizedException"}
834836
],
835-
"documentation":"<p>Retrieves the list of tags for an IoT SiteWise resource.</p>"
837+
"documentation":"<p>Retrieves the list of tags for an IoT SiteWise resource.</p>",
838+
"endpoint":{"hostPrefix":"api."}
836839
},
837840
"PutDefaultEncryptionConfiguration":{
838841
"name":"PutDefaultEncryptionConfiguration",
@@ -849,7 +852,8 @@
849852
{"shape":"LimitExceededException"},
850853
{"shape":"ConflictingOperationException"}
851854
],
852-
"documentation":"<p>Sets the default encryption configuration for the Amazon Web Services account. For more information, see <a href=\"https://docs.aws.amazon.com/iot-sitewise/latest/userguide/key-management.html\">Key management</a> in the <i>IoT SiteWise User Guide</i>.</p>"
855+
"documentation":"<p>Sets the default encryption configuration for the Amazon Web Services account. For more information, see <a href=\"https://docs.aws.amazon.com/iot-sitewise/latest/userguide/key-management.html\">Key management</a> in the <i>IoT SiteWise User Guide</i>.</p>",
856+
"endpoint":{"hostPrefix":"api."}
853857
},
854858
"PutLoggingOptions":{
855859
"name":"PutLoggingOptions",
@@ -867,7 +871,7 @@
867871
{"shape":"ResourceNotFoundException"}
868872
],
869873
"documentation":"<p>Sets logging options for IoT SiteWise.</p>",
870-
"endpoint":{"hostPrefix":"model."}
874+
"endpoint":{"hostPrefix":"api."}
871875
},
872876
"PutStorageConfiguration":{
873877
"name":"PutStorageConfiguration",
@@ -886,7 +890,8 @@
886890
{"shape":"LimitExceededException"},
887891
{"shape":"ConflictingOperationException"}
888892
],
889-
"documentation":"<p>Configures storage settings for IoT SiteWise.</p>"
893+
"documentation":"<p>Configures storage settings for IoT SiteWise.</p>",
894+
"endpoint":{"hostPrefix":"api."}
890895
},
891896
"TagResource":{
892897
"name":"TagResource",
@@ -906,7 +911,8 @@
906911
{"shape":"UnauthorizedException"},
907912
{"shape":"TooManyTagsException"}
908913
],
909-
"documentation":"<p>Adds tags to an IoT SiteWise resource. If a tag already exists for the resource, this operation updates the tag's value.</p>"
914+
"documentation":"<p>Adds tags to an IoT SiteWise resource. If a tag already exists for the resource, this operation updates the tag's value.</p>",
915+
"endpoint":{"hostPrefix":"api."}
910916
},
911917
"UntagResource":{
912918
"name":"UntagResource",
@@ -925,7 +931,8 @@
925931
{"shape":"LimitExceededException"},
926932
{"shape":"UnauthorizedException"}
927933
],
928-
"documentation":"<p>Removes a tag from an IoT SiteWise resource.</p>"
934+
"documentation":"<p>Removes a tag from an IoT SiteWise resource.</p>",
935+
"endpoint":{"hostPrefix":"api."}
929936
},
930937
"UpdateAccessPolicy":{
931938
"name":"UpdateAccessPolicy",
@@ -963,7 +970,7 @@
963970
{"shape":"ConflictingOperationException"}
964971
],
965972
"documentation":"<p>Updates an asset's name. 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>",
966-
"endpoint":{"hostPrefix":"model."}
973+
"endpoint":{"hostPrefix":"api."}
967974
},
968975
"UpdateAssetModel":{
969976
"name":"UpdateAssetModel",
@@ -984,7 +991,7 @@
984991
{"shape":"ConflictingOperationException"}
985992
],
986993
"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>",
987-
"endpoint":{"hostPrefix":"model."}
994+
"endpoint":{"hostPrefix":"api."}
988995
},
989996
"UpdateAssetProperty":{
990997
"name":"UpdateAssetProperty",
@@ -1001,7 +1008,7 @@
10011008
{"shape":"ConflictingOperationException"}
10021009
],
10031010
"documentation":"<p>Updates an asset property's alias and notification state.</p> <important> <p>This operation overwrites the property's existing alias and notification state. To keep your existing property's alias or notification state, you must include the existing values in the UpdateAssetProperty request. For more information, see <a href=\"https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAssetProperty.html\">DescribeAssetProperty</a>.</p> </important>",
1004-
"endpoint":{"hostPrefix":"model."}
1011+
"endpoint":{"hostPrefix":"api."}
10051012
},
10061013
"UpdateDashboard":{
10071014
"name":"UpdateDashboard",
@@ -1036,7 +1043,7 @@
10361043
{"shape":"ThrottlingException"}
10371044
],
10381045
"documentation":"<p>Updates a gateway's name.</p>",
1039-
"endpoint":{"hostPrefix":"edge."}
1046+
"endpoint":{"hostPrefix":"api."}
10401047
},
10411048
"UpdateGatewayCapabilityConfiguration":{
10421049
"name":"UpdateGatewayCapabilityConfiguration",
@@ -1056,7 +1063,7 @@
10561063
{"shape":"LimitExceededException"}
10571064
],
10581065
"documentation":"<p>Updates a gateway capability configuration or defines a new capability configuration. Each gateway capability defines data sources for a gateway. A capability configuration can contain multiple data source configurations. If you define OPC-UA sources for a gateway in the IoT SiteWise console, all of your OPC-UA sources are stored in one capability configuration. To list all capability configurations for a gateway, use <a href=\"https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeGateway.html\">DescribeGateway</a>.</p>",
1059-
"endpoint":{"hostPrefix":"edge."}
1066+
"endpoint":{"hostPrefix":"api."}
10601067
},
10611068
"UpdatePortal":{
10621069
"name":"UpdatePortal",

0 commit comments

Comments
 (0)