aws iot sitewise · aws iot sitewise api reference welcome welcome to the aws iot sitewise api...
Post on 22-May-2020
49 Views
Preview:
TRANSCRIPT
AWS IoT SiteWiseAPI Reference
API Version 2019-12-02
AWS IoT SiteWise API Reference
AWS IoT SiteWise: API ReferenceCopyright © 2020 Amazon Web Services, Inc. and/or its affiliates. All rights reserved.
Amazon's trademarks and trade dress may not be used in connection with any product or service that is notAmazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages ordiscredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who mayor may not be affiliated with, connected to, or sponsored by Amazon.
AWS IoT SiteWise API Reference
Table of Contents. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xiv
Welcome .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1Actions .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
AssociateAssets ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
BatchAssociateProjectAssets ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
BatchDisassociateProjectAssets ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
BatchPutAssetPropertyValue .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
CreateAccessPolicy .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
CreateAsset ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
CreateAssetModel ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
API Version 2019-12-02iii
AWS IoT SiteWise API Reference
Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
CreateDashboard .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
CreateGateway .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
CreatePortal ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
CreateProject ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
DeleteAccessPolicy .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
DeleteAsset ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
DeleteAssetModel ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
API Version 2019-12-02iv
AWS IoT SiteWise API Reference
Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
DeleteDashboard .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
DeleteGateway .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
DeletePortal ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
DeleteProject ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
DescribeAccessPolicy .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
DescribeAsset ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
DescribeAssetModel ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
API Version 2019-12-02v
AWS IoT SiteWise API Reference
Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
DescribeAssetProperty .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
DescribeDashboard .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
DescribeGateway .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
DescribeGatewayCapabilityConfiguration .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
DescribeLoggingOptions .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
DescribePortal ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
DescribeProject ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
API Version 2019-12-02vi
AWS IoT SiteWise API Reference
Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
DisassociateAssets ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
GetAssetPropertyAggregates .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
GetAssetPropertyValue .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
GetAssetPropertyValueHistory .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
ListAccessPolicies ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
ListAssetModels ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
ListAssets ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
API Version 2019-12-02vii
AWS IoT SiteWise API Reference
See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117ListAssociatedAssets ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
ListDashboards .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
ListGateways .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
ListPortals ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
ListProjectAssets ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
ListProjects ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
ListTagsForResource .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
API Version 2019-12-02viii
AWS IoT SiteWise API Reference
PutLoggingOptions .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
TagResource .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
UntagResource .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
UpdateAccessPolicy .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
UpdateAsset ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
UpdateAssetModel ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
UpdateAssetProperty .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
UpdateDashboard .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
API Version 2019-12-02ix
AWS IoT SiteWise API Reference
Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
UpdateGateway .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
UpdateGatewayCapabilityConfiguration .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165
UpdatePortal ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
UpdateProject ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171
Data Types .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173AccessPolicySummary .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
AggregatedValue .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
Aggregates .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
AssetErrorDetails ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
AssetHierarchy .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181
AssetModelHierarchy .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
API Version 2019-12-02x
AWS IoT SiteWise API Reference
See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182AssetModelHierarchyDefinition .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
AssetModelProperty .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184
AssetModelPropertyDefinition .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
AssetModelStatus .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188
AssetModelSummary .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
AssetProperty .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192
AssetPropertyValue .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
AssetStatus .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
AssetSummary .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
AssociatedAssetsSummary .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
Attribute .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
BatchPutAssetPropertyError ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
BatchPutAssetPropertyErrorEntry .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
DashboardSummary .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
ErrorDetails ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204
ExpressionVariable .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
GatewayCapabilitySummary .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206
GatewayPlatform ..... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207
GatewaySummary .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208
API Version 2019-12-02xi
AWS IoT SiteWise API Reference
See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208Greengrass .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
GroupIdentity ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211
Identity ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212
Image .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213
ImageFile ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214
ImageLocation .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
LoggingOptions .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216
Measurement .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217
Metric ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218
MetricWindow ..... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219
MonitorErrorDetails ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
PortalResource .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221
PortalStatus .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222
PortalSummary .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224
ProjectResource .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225
ProjectSummary .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226
Property .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229
PropertyNotification .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230
PropertyType .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231
API Version 2019-12-02xii
AWS IoT SiteWise API Reference
See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231PutAssetPropertyValueEntry .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232
Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233
Resource .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234
TimeInNanos .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235
Transform ..... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236
TumblingWindow ..... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237
UserIdentity ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238
VariableValue .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239
Variant .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240
Common Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241Common Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243
API Version 2019-12-02xiii
AWS IoT SiteWise API Reference
The AWS IoT SiteWise service is currently in preview. Under preview service terms and conditions, theservice is subject to change.
API Version 2019-12-02xiv
AWS IoT SiteWise API Reference
WelcomeWelcome to the AWS IoT SiteWise API Reference. AWS IoT SiteWise is an AWS service that connectsIndustrial Internet of Things (IIoT) devices to the power of the AWS Cloud. For more information, see theAWS IoT SiteWise User Guide. For information about AWS IoT SiteWise quotas, see Quotas in the AWS IoTSiteWise User Guide.
This document was last published on May 22, 2020.
API Version 2019-12-021
AWS IoT SiteWise API Reference
ActionsThe following actions are supported:
• AssociateAssets (p. 4)• BatchAssociateProjectAssets (p. 7)• BatchDisassociateProjectAssets (p. 10)• BatchPutAssetPropertyValue (p. 13)• CreateAccessPolicy (p. 17)• CreateAsset (p. 21)• CreateAssetModel (p. 25)• CreateDashboard (p. 30)• CreateGateway (p. 34)• CreatePortal (p. 37)• CreateProject (p. 42)• DeleteAccessPolicy (p. 46)• DeleteAsset (p. 48)• DeleteAssetModel (p. 51)• DeleteDashboard (p. 54)• DeleteGateway (p. 56)• DeletePortal (p. 58)• DeleteProject (p. 61)• DescribeAccessPolicy (p. 63)• DescribeAsset (p. 66)• DescribeAssetModel (p. 70)• DescribeAssetProperty (p. 74)• DescribeDashboard (p. 77)• DescribeGateway (p. 80)• DescribeGatewayCapabilityConfiguration (p. 83)• DescribeLoggingOptions (p. 86)• DescribePortal (p. 88)• DescribeProject (p. 92)• DisassociateAssets (p. 95)• GetAssetPropertyAggregates (p. 98)• GetAssetPropertyValue (p. 102)• GetAssetPropertyValueHistory (p. 105)• ListAccessPolicies (p. 109)• ListAssetModels (p. 112)• ListAssets (p. 115)• ListAssociatedAssets (p. 118)• ListDashboards (p. 121)• ListGateways (p. 124)• ListPortals (p. 127)• ListProjectAssets (p. 130)
API Version 2019-12-022
AWS IoT SiteWise API Reference
• ListProjects (p. 133)• ListTagsForResource (p. 136)• PutLoggingOptions (p. 138)• TagResource (p. 140)• UntagResource (p. 142)• UpdateAccessPolicy (p. 144)• UpdateAsset (p. 147)• UpdateAssetModel (p. 150)• UpdateAssetProperty (p. 155)• UpdateDashboard (p. 158)• UpdateGateway (p. 161)• UpdateGatewayCapabilityConfiguration (p. 163)• UpdatePortal (p. 166)• UpdateProject (p. 170)
API Version 2019-12-023
AWS IoT SiteWise API ReferenceAssociateAssets
AssociateAssetsAssociates a child asset with the given parent asset through a hierarchy defined in the parent asset'smodel. For more information, see Associating Assets in the AWS IoT SiteWise User Guide.
Request SyntaxPOST /assets/assetId/associate HTTP/1.1Content-type: application/json
{ "childAssetId": "string", "clientToken": "string", "hierarchyId": "string"}
URI Request ParametersThe request requires the following URI parameters.
assetId (p. 4)
The ID of the parent asset.
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Request BodyThe request accepts the following data in JSON format.
childAssetId (p. 4)
The ID of the child asset to be associated.
Type: String
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Required: YesclientToken (p. 4)
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request.Don't reuse this client token if a new idempotent request is required.
Type: String
Length Constraints: Minimum length of 36. Maximum length of 64.
Pattern: \S{36,64}
Required: No
API Version 2019-12-024
AWS IoT SiteWise API ReferenceResponse Syntax
hierarchyId (p. 4)
The ID of a hierarchy in the parent asset's model. Hierarchies allow different groupings of assets tobe formed that all come from the same asset model. For more information, see Asset Hierarchies inthe AWS IoT SiteWise User Guide.
Type: String
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Required: Yes
Response SyntaxHTTP/1.1 200
Response ElementsIf the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 243).
ConflictingOperationException
Your request has conflicting operations. This can occur if you're trying to perform more than oneoperation on the same resource at the same time.
HTTP Status Code: 409InternalFailureException
AWS IoT SiteWise can't process your request right now. Try again later.
HTTP Status Code: 500InvalidRequestException
The request isn't valid. This can occur if your request contains malformed JSON or unsupportedcharacters. Check your request and try again.
HTTP Status Code: 400LimitExceededException
You've reached the limit for a resource. For example, this can occur if you're trying to associate morethan the allowed number of child assets or attempting to create more than the allowed number ofproperties for an asset model.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
HTTP Status Code: 410ResourceNotFoundException
The requested resource can't be found.
API Version 2019-12-025
AWS IoT SiteWise API ReferenceSee Also
HTTP Status Code: 404ThrottlingException
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoTSiteWise assets that can be created per second, the allowed number of messages per second, and soon.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
HTTP Status Code: 429
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2019-12-026
AWS IoT SiteWise API ReferenceBatchAssociateProjectAssets
BatchAssociateProjectAssetsAssociates a group (batch) of assets with an AWS IoT SiteWise Monitor project.
Request SyntaxPOST /projects/projectId/assets/associate HTTP/1.1Content-type: application/json
{ "assetIds": [ "string" ], "clientToken": "string"}
URI Request ParametersThe request requires the following URI parameters.
projectId (p. 7)
The ID of the project to which to associate the assets.
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Request BodyThe request accepts the following data in JSON format.
assetIds (p. 7)
The IDs of the assets to be associated to the project.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Required: YesclientToken (p. 7)
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request.Don't reuse this client token if a new idempotent request is required.
Type: String
Length Constraints: Minimum length of 36. Maximum length of 64.
Pattern: \S{36,64}
Required: No
API Version 2019-12-027
AWS IoT SiteWise API ReferenceResponse Syntax
Response SyntaxHTTP/1.1 200Content-type: application/json
{ "errors": [ { "assetId": "string", "code": "string", "message": "string" } ]}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
errors (p. 8)
A list of associated error information, if any.
Type: Array of AssetErrorDetails (p. 180) objects
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 243).
InternalFailureException
AWS IoT SiteWise can't process your request right now. Try again later.
HTTP Status Code: 500InvalidRequestException
The request isn't valid. This can occur if your request contains malformed JSON or unsupportedcharacters. Check your request and try again.
HTTP Status Code: 400LimitExceededException
You've reached the limit for a resource. For example, this can occur if you're trying to associate morethan the allowed number of child assets or attempting to create more than the allowed number ofproperties for an asset model.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
HTTP Status Code: 410ResourceNotFoundException
The requested resource can't be found.
HTTP Status Code: 404
API Version 2019-12-028
AWS IoT SiteWise API ReferenceSee Also
ThrottlingException
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoTSiteWise assets that can be created per second, the allowed number of messages per second, and soon.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
HTTP Status Code: 429
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2019-12-029
AWS IoT SiteWise API ReferenceBatchDisassociateProjectAssets
BatchDisassociateProjectAssetsDisassociates a group (batch) of assets from an AWS IoT SiteWise Monitor project.
Request SyntaxPOST /projects/projectId/assets/disassociate HTTP/1.1Content-type: application/json
{ "assetIds": [ "string" ], "clientToken": "string"}
URI Request ParametersThe request requires the following URI parameters.
projectId (p. 10)
The ID of the project from which to disassociate the assets.
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Request BodyThe request accepts the following data in JSON format.
assetIds (p. 10)
The IDs of the assets to be disassociated from the project.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Required: YesclientToken (p. 10)
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request.Don't reuse this client token if a new idempotent request is required.
Type: String
Length Constraints: Minimum length of 36. Maximum length of 64.
Pattern: \S{36,64}
Required: No
API Version 2019-12-0210
AWS IoT SiteWise API ReferenceResponse Syntax
Response SyntaxHTTP/1.1 200Content-type: application/json
{ "errors": [ { "assetId": "string", "code": "string", "message": "string" } ]}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
errors (p. 11)
A list of associated error information, if any.
Type: Array of AssetErrorDetails (p. 180) objects
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 243).
InternalFailureException
AWS IoT SiteWise can't process your request right now. Try again later.
HTTP Status Code: 500InvalidRequestException
The request isn't valid. This can occur if your request contains malformed JSON or unsupportedcharacters. Check your request and try again.
HTTP Status Code: 400ResourceNotFoundException
The requested resource can't be found.
HTTP Status Code: 404ThrottlingException
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoTSiteWise assets that can be created per second, the allowed number of messages per second, and soon.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
HTTP Status Code: 429
API Version 2019-12-0211
AWS IoT SiteWise API ReferenceSee Also
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2019-12-0212
AWS IoT SiteWise API ReferenceBatchPutAssetPropertyValue
BatchPutAssetPropertyValueSends a list of asset property values to AWS IoT SiteWise. Each value is a timestamp-quality-value (TQV)data point. For more information, see Ingesting Data Using the API in the AWS IoT SiteWise User Guide.
To identify an asset property, you must specify one of the following:
• The assetId and propertyId of an asset property.
• A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.
ImportantWith respect to Unix epoch time, AWS IoT SiteWise accepts only TQVs that have a timestampof no more than 15 minutes in the past and no more than 5 minutes in the future. AWS IoTSiteWise rejects timestamps outside of the inclusive range of [-15, +5] minutes and returns aTimestampOutOfRangeException error.For each asset property, AWS IoT SiteWise overwrites TQVs with duplicate timestamps unlessthe newer TQV has a different quality. For example, if you store a TQV {T1, GOOD, V1}, thenstoring {T1, GOOD, V2} replaces the existing TQV.
Request Syntax
POST /properties HTTP/1.1Content-type: application/json
{ "entries": [ { "assetId": "string", "entryId": "string", "propertyAlias": "string", "propertyId": "string", "propertyValues": [ { "quality": "string", "timestamp": { "offsetInNanos": number, "timeInSeconds": number }, "value": { "booleanValue": boolean, "doubleValue": number, "integerValue": number, "stringValue": "string" } } ] } ]}
URI Request ParametersThe request does not use any URI parameters.
API Version 2019-12-0213
AWS IoT SiteWise API ReferenceRequest Body
Request BodyThe request accepts the following data in JSON format.
entries (p. 13)
The list of asset property value entries for the batch put request. You can specify up to 10 entriesper request.
Type: Array of PutAssetPropertyValueEntry (p. 232) objects
Required: Yes
Response Syntax
HTTP/1.1 200Content-type: application/json
{ "errorEntries": [ { "entryId": "string", "errors": [ { "errorCode": "string", "errorMessage": "string", "timestamps": [ { "offsetInNanos": number, "timeInSeconds": number } ] } ] } ]}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
errorEntries (p. 14)
A list of the errors (if any) associated with the batch put request. Each error entry contains theentryId of the entry that failed.
Type: Array of BatchPutAssetPropertyErrorEntry (p. 201) objects
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 243).
API Version 2019-12-0214
AWS IoT SiteWise API ReferenceSee Also
ConflictingOperationException
Your request has conflicting operations. This can occur if you're trying to perform more than oneoperation on the same resource at the same time.
HTTP Status Code: 409InternalFailureException
AWS IoT SiteWise can't process your request right now. Try again later.
HTTP Status Code: 500InvalidRequestException
The request isn't valid. This can occur if your request contains malformed JSON or unsupportedcharacters. Check your request and try again.
HTTP Status Code: 400LimitExceededException
You've reached the limit for a resource. For example, this can occur if you're trying to associate morethan the allowed number of child assets or attempting to create more than the allowed number ofproperties for an asset model.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
HTTP Status Code: 410ResourceNotFoundException
The requested resource can't be found.
HTTP Status Code: 404ServiceUnavailableException
The requested service is unavailable.
HTTP Status Code: 503ThrottlingException
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoTSiteWise assets that can be created per second, the allowed number of messages per second, and soon.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
HTTP Status Code: 429
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript
API Version 2019-12-0215
AWS IoT SiteWise API ReferenceSee Also
• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2019-12-0216
AWS IoT SiteWise API ReferenceCreateAccessPolicy
CreateAccessPolicyCreates an access policy that grants the specified AWS Single Sign-On user or group access to thespecified AWS IoT SiteWise Monitor portal or project resource.
Request SyntaxPOST /access-policies HTTP/1.1Content-type: application/json
{ "accessPolicyIdentity": { "group": { "id": "string" }, "user": { "id": "string" } }, "accessPolicyPermission": "string", "accessPolicyResource": { "portal": { "id": "string" }, "project": { "id": "string" } }, "clientToken": "string", "tags": { "string" : "string" }}
URI Request ParametersThe request does not use any URI parameters.
Request BodyThe request accepts the following data in JSON format.
accessPolicyIdentity (p. 17)
The identity for this access policy. Choose either a user or a group but not both.
Type: Identity (p. 212) object
Required: YesaccessPolicyPermission (p. 17)
The permission level for this access policy. Note that a project ADMINISTRATOR is also known as aproject owner.
Type: String
Valid Values: ADMINISTRATOR | VIEWER
API Version 2019-12-0217
AWS IoT SiteWise API ReferenceResponse Syntax
Required: YesaccessPolicyResource (p. 17)
The AWS IoT SiteWise Monitor resource for this access policy. Choose either portal or project butnot both.
Type: Resource (p. 234) object
Required: YesclientToken (p. 17)
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request.Don't reuse this client token if a new idempotent request is required.
Type: String
Length Constraints: Minimum length of 36. Maximum length of 64.
Pattern: \S{36,64}
Required: Notags (p. 17)
A list of key-value pairs that contain metadata for the access policy. For more information, seeTagging your AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide.
Type: String to string map
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Value Length Constraints: Minimum length of 0. Maximum length of 256.
Required: No
Response SyntaxHTTP/1.1 201Content-type: application/json
{ "accessPolicyArn": "string", "accessPolicyId": "string"}
Response ElementsIf the action is successful, the service sends back an HTTP 201 response.
The following data is returned in JSON format by the service.
accessPolicyArn (p. 18)
The ARN of the access policy, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:access-policy/${AccessPolicyId}
Type: String
API Version 2019-12-0218
AWS IoT SiteWise API ReferenceErrors
Length Constraints: Minimum length of 1. Maximum length of 1600.
Pattern: .*accessPolicyId (p. 18)
The ID of the access policy.
Type: String
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 243).
InternalFailureException
AWS IoT SiteWise can't process your request right now. Try again later.
HTTP Status Code: 500InvalidRequestException
The request isn't valid. This can occur if your request contains malformed JSON or unsupportedcharacters. Check your request and try again.
HTTP Status Code: 400LimitExceededException
You've reached the limit for a resource. For example, this can occur if you're trying to associate morethan the allowed number of child assets or attempting to create more than the allowed number ofproperties for an asset model.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
HTTP Status Code: 410ResourceNotFoundException
The requested resource can't be found.
HTTP Status Code: 404ThrottlingException
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoTSiteWise assets that can be created per second, the allowed number of messages per second, and soon.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
HTTP Status Code: 429
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
API Version 2019-12-0219
AWS IoT SiteWise API ReferenceSee Also
• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2019-12-0220
AWS IoT SiteWise API ReferenceCreateAsset
CreateAssetCreates an asset from an existing asset model. For more information, see Creating Assets in the AWS IoTSiteWise User Guide.
Request SyntaxPOST /assets HTTP/1.1Content-type: application/json
{ "assetModelId": "string", "assetName": "string", "clientToken": "string", "tags": { "string" : "string" }}
URI Request ParametersThe request does not use any URI parameters.
Request BodyThe request accepts the following data in JSON format.
assetModelId (p. 21)
The ID of the asset model from which to create the asset.
Type: String
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Required: YesassetName (p. 21)
A unique, friendly name for the asset.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: [^\u0000-\u001F\u007F]+
Required: YesclientToken (p. 21)
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request.Don't reuse this client token if a new idempotent request is required.
Type: String
Length Constraints: Minimum length of 36. Maximum length of 64.
API Version 2019-12-0221
AWS IoT SiteWise API ReferenceResponse Syntax
Pattern: \S{36,64}
Required: Notags (p. 21)
A list of key-value pairs that contain metadata for the asset. For more information, see Tagging yourAWS IoT SiteWise resources in the AWS IoT SiteWise User Guide.
Type: String to string map
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Value Length Constraints: Minimum length of 0. Maximum length of 256.
Required: No
Response SyntaxHTTP/1.1 202Content-type: application/json
{ "assetArn": "string", "assetId": "string", "assetStatus": { "error": { "code": "string", "message": "string" }, "state": "string" }}
Response ElementsIf the action is successful, the service sends back an HTTP 202 response.
The following data is returned in JSON format by the service.
assetArn (p. 22)
The ARN of the asset, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
Pattern: .*assetId (p. 22)
The ID of the asset. This ID uniquely identifies the asset within AWS IoT SiteWise and can be usedwith other AWS IoT SiteWise APIs.
Type: String
Length Constraints: Fixed length of 36.
API Version 2019-12-0222
AWS IoT SiteWise API ReferenceErrors
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$assetStatus (p. 22)
The status of the asset, which contains a state (CREATING after successfully calling this operation)and any error message.
Type: AssetStatus (p. 194) object
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 243).
ConflictingOperationException
Your request has conflicting operations. This can occur if you're trying to perform more than oneoperation on the same resource at the same time.
HTTP Status Code: 409InternalFailureException
AWS IoT SiteWise can't process your request right now. Try again later.
HTTP Status Code: 500InvalidRequestException
The request isn't valid. This can occur if your request contains malformed JSON or unsupportedcharacters. Check your request and try again.
HTTP Status Code: 400LimitExceededException
You've reached the limit for a resource. For example, this can occur if you're trying to associate morethan the allowed number of child assets or attempting to create more than the allowed number ofproperties for an asset model.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
HTTP Status Code: 410ResourceAlreadyExistsException
The resource already exists.
HTTP Status Code: 409ResourceNotFoundException
The requested resource can't be found.
HTTP Status Code: 404ThrottlingException
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoTSiteWise assets that can be created per second, the allowed number of messages per second, and soon.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
HTTP Status Code: 429
API Version 2019-12-0223
AWS IoT SiteWise API ReferenceSee Also
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2019-12-0224
AWS IoT SiteWise API ReferenceCreateAssetModel
CreateAssetModelCreates an asset model from specified property and hierarchy definitions. You create assets fromasset models. With asset models, you can easily create assets of the same type that have standardizeddefinitions. Each asset created from a model inherits the asset model's property and hierarchydefinitions. For more information, see Defining Asset Models in the AWS IoT SiteWise User Guide.
Request SyntaxPOST /asset-models HTTP/1.1Content-type: application/json
{ "assetModelDescription": "string", "assetModelHierarchies": [ { "childAssetModelId": "string", "name": "string" } ], "assetModelName": "string", "assetModelProperties": [ { "dataType": "string", "name": "string", "type": { "attribute": { "defaultValue": "string" }, "measurement": { }, "metric": { "expression": "string", "variables": [ { "name": "string", "value": { "hierarchyId": "string", "propertyId": "string" } } ], "window": { "tumbling": { "interval": "string" } } }, "transform": { "expression": "string", "variables": [ { "name": "string", "value": { "hierarchyId": "string", "propertyId": "string" } } ] } }, "unit": "string"
API Version 2019-12-0225
AWS IoT SiteWise API ReferenceURI Request Parameters
} ], "clientToken": "string", "tags": { "string" : "string" }}
URI Request ParametersThe request does not use any URI parameters.
Request BodyThe request accepts the following data in JSON format.
assetModelDescription (p. 25)
A description for the asset model.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: [^\u0000-\u001F\u007F]+
Required: NoassetModelHierarchies (p. 25)
The hierarchy definitions of the asset model. Each hierarchy specifies an asset model whose assetscan be children of any other assets created from this asset model. For more information, see AssetHierarchies in the AWS IoT SiteWise User Guide.
You can specify up to 10 hierarchies per asset model. For more information, see Quotas in the AWSIoT SiteWise User Guide.
Type: Array of AssetModelHierarchyDefinition (p. 183) objects
Required: NoassetModelName (p. 25)
A unique, friendly name for the asset model.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: [^\u0000-\u001F\u007F]+
Required: YesassetModelProperties (p. 25)
The property definitions of the asset model. For more information, see Asset Properties in the AWSIoT SiteWise User Guide.
You can specify up to 200 properties per asset model. For more information, see Quotas in the AWSIoT SiteWise User Guide.
Type: Array of AssetModelPropertyDefinition (p. 186) objects
API Version 2019-12-0226
AWS IoT SiteWise API ReferenceResponse Syntax
Required: NoclientToken (p. 25)
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request.Don't reuse this client token if a new idempotent request is required.
Type: String
Length Constraints: Minimum length of 36. Maximum length of 64.
Pattern: \S{36,64}
Required: Notags (p. 25)
A list of key-value pairs that contain metadata for the asset model. For more information, seeTagging your AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide.
Type: String to string map
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Value Length Constraints: Minimum length of 0. Maximum length of 256.
Required: No
Response SyntaxHTTP/1.1 202Content-type: application/json
{ "assetModelArn": "string", "assetModelId": "string", "assetModelStatus": { "error": { "code": "string", "message": "string" }, "state": "string" }}
Response ElementsIf the action is successful, the service sends back an HTTP 202 response.
The following data is returned in JSON format by the service.
assetModelArn (p. 27)
The ARN of the asset model, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
API Version 2019-12-0227
AWS IoT SiteWise API ReferenceErrors
Pattern: .*assetModelId (p. 27)
The ID of the asset model. You can use this ID when you call other AWS IoT SiteWise APIs.
Type: String
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$assetModelStatus (p. 27)
The status of the asset model, which contains a state (CREATING after successfully calling thisoperation) and any error message.
Type: AssetModelStatus (p. 188) object
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 243).
ConflictingOperationException
Your request has conflicting operations. This can occur if you're trying to perform more than oneoperation on the same resource at the same time.
HTTP Status Code: 409InternalFailureException
AWS IoT SiteWise can't process your request right now. Try again later.
HTTP Status Code: 500InvalidRequestException
The request isn't valid. This can occur if your request contains malformed JSON or unsupportedcharacters. Check your request and try again.
HTTP Status Code: 400LimitExceededException
You've reached the limit for a resource. For example, this can occur if you're trying to associate morethan the allowed number of child assets or attempting to create more than the allowed number ofproperties for an asset model.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
HTTP Status Code: 410ResourceAlreadyExistsException
The resource already exists.
HTTP Status Code: 409ResourceNotFoundException
The requested resource can't be found.
HTTP Status Code: 404
API Version 2019-12-0228
AWS IoT SiteWise API ReferenceSee Also
ThrottlingException
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoTSiteWise assets that can be created per second, the allowed number of messages per second, and soon.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
HTTP Status Code: 429
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2019-12-0229
AWS IoT SiteWise API ReferenceCreateDashboard
CreateDashboardCreates a dashboard in an AWS IoT SiteWise Monitor project.
Request SyntaxPOST /dashboards HTTP/1.1Content-type: application/json
{ "clientToken": "string", "dashboardDefinition": "string", "dashboardDescription": "string", "dashboardName": "string", "projectId": "string", "tags": { "string" : "string" }}
URI Request ParametersThe request does not use any URI parameters.
Request BodyThe request accepts the following data in JSON format.
clientToken (p. 30)
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request.Don't reuse this client token if a new idempotent request is required.
Type: String
Length Constraints: Minimum length of 36. Maximum length of 64.
Pattern: \S{36,64}
Required: No
dashboardDefinition (p. 30)
The dashboard definition specified in a JSON literal. For detailed information, see CreatingDashboards (CLI) in the AWS IoT SiteWise User Guide.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 204800.
Pattern: .+
Required: Yes
dashboardDescription (p. 30)
A description for the dashboard.
API Version 2019-12-0230
AWS IoT SiteWise API ReferenceResponse Syntax
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: [^\u0000-\u001F\u007F]+
Required: NodashboardName (p. 30)
A friendly name for the dashboard.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: [^\u0000-\u001F\u007F]+
Required: YesprojectId (p. 30)
The ID of the project in which to create the dashboard.
Type: String
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Required: Yestags (p. 30)
A list of key-value pairs that contain metadata for the dashboard. For more information, see Taggingyour AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide.
Type: String to string map
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Value Length Constraints: Minimum length of 0. Maximum length of 256.
Required: No
Response SyntaxHTTP/1.1 201Content-type: application/json
{ "dashboardArn": "string", "dashboardId": "string"}
Response ElementsIf the action is successful, the service sends back an HTTP 201 response.
The following data is returned in JSON format by the service.
API Version 2019-12-0231
AWS IoT SiteWise API ReferenceErrors
dashboardArn (p. 31)
The ARN of the dashboard, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:dashboard/${DashboardId}
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
Pattern: .*dashboardId (p. 31)
The ID of the dashboard.
Type: String
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 243).
InternalFailureException
AWS IoT SiteWise can't process your request right now. Try again later.
HTTP Status Code: 500InvalidRequestException
The request isn't valid. This can occur if your request contains malformed JSON or unsupportedcharacters. Check your request and try again.
HTTP Status Code: 400LimitExceededException
You've reached the limit for a resource. For example, this can occur if you're trying to associate morethan the allowed number of child assets or attempting to create more than the allowed number ofproperties for an asset model.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
HTTP Status Code: 410ResourceNotFoundException
The requested resource can't be found.
HTTP Status Code: 404ThrottlingException
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoTSiteWise assets that can be created per second, the allowed number of messages per second, and soon.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
HTTP Status Code: 429
API Version 2019-12-0232
AWS IoT SiteWise API ReferenceSee Also
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2019-12-0233
AWS IoT SiteWise API ReferenceCreateGateway
CreateGatewayCreates a gateway, which is a virtual or edge device that delivers industrial data streams from localservers to AWS IoT SiteWise. For more information, see Ingesting data using a gateway in the AWS IoTSiteWise User Guide.
Request SyntaxPOST /20200301/gateways HTTP/1.1Content-type: application/json
{ "gatewayName": "string", "gatewayPlatform": { "greengrass": { "groupArn": "string" } }, "tags": { "string" : "string" }}
URI Request ParametersThe request does not use any URI parameters.
Request BodyThe request accepts the following data in JSON format.
gatewayName (p. 34)
A unique, friendly name for the gateway.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: [^\u0000-\u001F\u007F]+
Required: YesgatewayPlatform (p. 34)
The gateway's platform. You can only specify one platform in a gateway.
Type: GatewayPlatform (p. 207) object
Required: Yestags (p. 34)
A list of key-value pairs that contain metadata for the gateway. For more information, see Taggingyour AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide.
Type: String to string map
Key Length Constraints: Minimum length of 1. Maximum length of 128.
API Version 2019-12-0234
AWS IoT SiteWise API ReferenceResponse Syntax
Value Length Constraints: Minimum length of 0. Maximum length of 256.
Required: No
Response SyntaxHTTP/1.1 201Content-type: application/json
{ "gatewayArn": "string", "gatewayId": "string"}
Response ElementsIf the action is successful, the service sends back an HTTP 201 response.
The following data is returned in JSON format by the service.
gatewayArn (p. 35)
The ARN of the gateway, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:gateway/${GatewayId}
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
Pattern: .*gatewayId (p. 35)
The ID of the gateway device. You can use this ID when you call other AWS IoT SiteWise APIs.
Type: String
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 243).
InternalFailureException
AWS IoT SiteWise can't process your request right now. Try again later.
HTTP Status Code: 500InvalidRequestException
The request isn't valid. This can occur if your request contains malformed JSON or unsupportedcharacters. Check your request and try again.
HTTP Status Code: 400
API Version 2019-12-0235
AWS IoT SiteWise API ReferenceSee Also
LimitExceededException
You've reached the limit for a resource. For example, this can occur if you're trying to associate morethan the allowed number of child assets or attempting to create more than the allowed number ofproperties for an asset model.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
HTTP Status Code: 410ResourceAlreadyExistsException
The resource already exists.
HTTP Status Code: 409ThrottlingException
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoTSiteWise assets that can be created per second, the allowed number of messages per second, and soon.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
HTTP Status Code: 429
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2019-12-0236
AWS IoT SiteWise API ReferenceCreatePortal
CreatePortalCreates a portal, which can contain projects and dashboards. Before you can create a portal, you mustconfigure AWS Single Sign-On in the current Region. AWS IoT SiteWise Monitor uses AWS SSO tomanage user permissions. For more information, see Enabling AWS SSO in the AWS IoT SiteWise UserGuide.
NoteBefore you can sign in to a new portal, you must add at least one AWS SSO user or group tothat portal. For more information, see Adding or Removing Portal Administrators in the AWS IoTSiteWise User Guide.
Request SyntaxPOST /portals HTTP/1.1Content-type: application/json
{ "clientToken": "string", "portalContactEmail": "string", "portalDescription": "string", "portalLogoImageFile": { "data": blob, "type": "string" }, "portalName": "string", "roleArn": "string", "tags": { "string" : "string" }}
URI Request ParametersThe request does not use any URI parameters.
Request BodyThe request accepts the following data in JSON format.
clientToken (p. 37)
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request.Don't reuse this client token if a new idempotent request is required.
Type: String
Length Constraints: Minimum length of 36. Maximum length of 64.
Pattern: \S{36,64}
Required: NoportalContactEmail (p. 37)
The AWS administrator's contact email address.
Type: String
API Version 2019-12-0237
AWS IoT SiteWise API ReferenceRequest Body
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: [^@]+@[^@]+
Required: YesportalDescription (p. 37)
A description for the portal.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: [^\u0000-\u001F\u007F]+
Required: NoportalLogoImageFile (p. 37)
A logo image to display in the portal. Upload a square, high-resolution image. The image isdisplayed on a dark background.
Type: ImageFile (p. 214) object
Required: NoportalName (p. 37)
A friendly name for the portal.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: [^\u0000-\u001F\u007F]+
Required: YesroleArn (p. 37)
The ARN of a service role that allows the portal's users to access your AWS IoT SiteWise resources onyour behalf. For more information, see Using service roles for AWS IoT SiteWise Monitor in the AWSIoT SiteWise User Guide.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
Pattern: .*
Required: Yestags (p. 37)
A list of key-value pairs that contain metadata for the portal. For more information, see Taggingyour AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide.
Type: String to string map
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Value Length Constraints: Minimum length of 0. Maximum length of 256.
Required: No
API Version 2019-12-0238
AWS IoT SiteWise API ReferenceResponse Syntax
Response SyntaxHTTP/1.1 202Content-type: application/json
{ "portalArn": "string", "portalId": "string", "portalStartUrl": "string", "portalStatus": { "error": { "code": "string", "message": "string" }, "state": "string" }, "ssoApplicationId": "string"}
Response ElementsIf the action is successful, the service sends back an HTTP 202 response.
The following data is returned in JSON format by the service.
portalArn (p. 39)
The ARN of the portal, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId}
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
Pattern: .*portalId (p. 39)
The ID of the created portal.
Type: String
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$portalStartUrl (p. 39)
The public URL for the AWS IoT SiteWise Monitor portal.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: ^(http|https)\://\S+portalStatus (p. 39)
The status of the portal, which contains a state (CREATING after successfully calling this operation)and any error message.
API Version 2019-12-0239
AWS IoT SiteWise API ReferenceErrors
Type: PortalStatus (p. 222) objectssoApplicationId (p. 39)
The associated AWS SSO application Id.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: ^[!-~]*
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 243).
InternalFailureException
AWS IoT SiteWise can't process your request right now. Try again later.
HTTP Status Code: 500InvalidRequestException
The request isn't valid. This can occur if your request contains malformed JSON or unsupportedcharacters. Check your request and try again.
HTTP Status Code: 400LimitExceededException
You've reached the limit for a resource. For example, this can occur if you're trying to associate morethan the allowed number of child assets or attempting to create more than the allowed number ofproperties for an asset model.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
HTTP Status Code: 410ResourceNotFoundException
The requested resource can't be found.
HTTP Status Code: 404ThrottlingException
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoTSiteWise assets that can be created per second, the allowed number of messages per second, and soon.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
HTTP Status Code: 429
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET
API Version 2019-12-0240
AWS IoT SiteWise API ReferenceSee Also
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2019-12-0241
AWS IoT SiteWise API ReferenceCreateProject
CreateProjectCreates a project in the specified portal.
Request SyntaxPOST /projects HTTP/1.1Content-type: application/json
{ "clientToken": "string", "portalId": "string", "projectDescription": "string", "projectName": "string", "tags": { "string" : "string" }}
URI Request ParametersThe request does not use any URI parameters.
Request BodyThe request accepts the following data in JSON format.
clientToken (p. 42)
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request.Don't reuse this client token if a new idempotent request is required.
Type: String
Length Constraints: Minimum length of 36. Maximum length of 64.
Pattern: \S{36,64}
Required: NoportalId (p. 42)
The ID of the portal in which to create the project.
Type: String
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Required: YesprojectDescription (p. 42)
A description for the project.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
API Version 2019-12-0242
AWS IoT SiteWise API ReferenceResponse Syntax
Pattern: [^\u0000-\u001F\u007F]+
Required: NoprojectName (p. 42)
A friendly name for the project.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: [^\u0000-\u001F\u007F]+
Required: Yestags (p. 42)
A list of key-value pairs that contain metadata for the project. For more information, see Taggingyour AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide.
Type: String to string map
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Value Length Constraints: Minimum length of 0. Maximum length of 256.
Required: No
Response SyntaxHTTP/1.1 201Content-type: application/json
{ "projectArn": "string", "projectId": "string"}
Response ElementsIf the action is successful, the service sends back an HTTP 201 response.
The following data is returned in JSON format by the service.
projectArn (p. 43)
The ARN of the project, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:project/${ProjectId}
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
Pattern: .*projectId (p. 43)
The ID of the project.
API Version 2019-12-0243
AWS IoT SiteWise API ReferenceErrors
Type: String
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 243).
InternalFailureException
AWS IoT SiteWise can't process your request right now. Try again later.
HTTP Status Code: 500InvalidRequestException
The request isn't valid. This can occur if your request contains malformed JSON or unsupportedcharacters. Check your request and try again.
HTTP Status Code: 400LimitExceededException
You've reached the limit for a resource. For example, this can occur if you're trying to associate morethan the allowed number of child assets or attempting to create more than the allowed number ofproperties for an asset model.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
HTTP Status Code: 410ResourceNotFoundException
The requested resource can't be found.
HTTP Status Code: 404ThrottlingException
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoTSiteWise assets that can be created per second, the allowed number of messages per second, and soon.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
HTTP Status Code: 429
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript
API Version 2019-12-0244
AWS IoT SiteWise API ReferenceSee Also
• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2019-12-0245
AWS IoT SiteWise API ReferenceDeleteAccessPolicy
DeleteAccessPolicyDeletes an access policy that grants the specified AWS Single Sign-On identity access to the specifiedAWS IoT SiteWise Monitor resource. You can use this operation to revoke access to an AWS IoT SiteWiseMonitor resource.
Request SyntaxDELETE /access-policies/accessPolicyId?clientToken=clientToken HTTP/1.1
URI Request ParametersThe request requires the following URI parameters.
accessPolicyId (p. 46)
The ID of the access policy to be deleted.
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$clientToken (p. 46)
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request.Don't reuse this client token if a new idempotent request is required.
Length Constraints: Minimum length of 36. Maximum length of 64.
Pattern: \S{36,64}
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 204
Response ElementsIf the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 243).
InternalFailureException
AWS IoT SiteWise can't process your request right now. Try again later.
HTTP Status Code: 500
API Version 2019-12-0246
AWS IoT SiteWise API ReferenceSee Also
InvalidRequestException
The request isn't valid. This can occur if your request contains malformed JSON or unsupportedcharacters. Check your request and try again.
HTTP Status Code: 400ResourceNotFoundException
The requested resource can't be found.
HTTP Status Code: 404ThrottlingException
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoTSiteWise assets that can be created per second, the allowed number of messages per second, and soon.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
HTTP Status Code: 429
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2019-12-0247
AWS IoT SiteWise API ReferenceDeleteAsset
DeleteAssetDeletes an asset. This action can't be undone. For more information, see Deleting Assets and Models inthe AWS IoT SiteWise User Guide.
NoteYou can't delete an asset that's associated to another asset. For more information, seeDisassociateAssets.
Request SyntaxDELETE /assets/assetId?clientToken=clientToken HTTP/1.1
URI Request ParametersThe request requires the following URI parameters.
assetId (p. 48)
The ID of the asset to delete.
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$clientToken (p. 48)
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request.Don't reuse this client token if a new idempotent request is required.
Length Constraints: Minimum length of 36. Maximum length of 64.
Pattern: \S{36,64}
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 202Content-type: application/json
{ "assetStatus": { "error": { "code": "string", "message": "string" }, "state": "string" }}
Response ElementsIf the action is successful, the service sends back an HTTP 202 response.
API Version 2019-12-0248
AWS IoT SiteWise API ReferenceErrors
The following data is returned in JSON format by the service.
assetStatus (p. 48)
The status of the asset, which contains a state (DELETING after successfully calling this operation)and any error message.
Type: AssetStatus (p. 194) object
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 243).
ConflictingOperationException
Your request has conflicting operations. This can occur if you're trying to perform more than oneoperation on the same resource at the same time.
HTTP Status Code: 409InternalFailureException
AWS IoT SiteWise can't process your request right now. Try again later.
HTTP Status Code: 500InvalidRequestException
The request isn't valid. This can occur if your request contains malformed JSON or unsupportedcharacters. Check your request and try again.
HTTP Status Code: 400ResourceNotFoundException
The requested resource can't be found.
HTTP Status Code: 404ThrottlingException
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoTSiteWise assets that can be created per second, the allowed number of messages per second, and soon.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
HTTP Status Code: 429
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript
API Version 2019-12-0249
AWS IoT SiteWise API ReferenceSee Also
• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2019-12-0250
AWS IoT SiteWise API ReferenceDeleteAssetModel
DeleteAssetModelDeletes an asset model. This action can't be undone. You must delete all assets created from an assetmodel before you can delete the model. Also, you can't delete an asset model if a parent asset modelexists that contains a property formula expression that depends on the asset model that you want todelete. For more information, see Deleting Assets and Models in the AWS IoT SiteWise User Guide.
Request SyntaxDELETE /asset-models/assetModelId?clientToken=clientToken HTTP/1.1
URI Request ParametersThe request requires the following URI parameters.
assetModelId (p. 51)
The ID of the asset model to delete.
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$clientToken (p. 51)
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request.Don't reuse this client token if a new idempotent request is required.
Length Constraints: Minimum length of 36. Maximum length of 64.
Pattern: \S{36,64}
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 202Content-type: application/json
{ "assetModelStatus": { "error": { "code": "string", "message": "string" }, "state": "string" }}
Response ElementsIf the action is successful, the service sends back an HTTP 202 response.
API Version 2019-12-0251
AWS IoT SiteWise API ReferenceErrors
The following data is returned in JSON format by the service.
assetModelStatus (p. 51)
The status of the asset model, which contains a state (DELETING after successfully calling thisoperation) and any error message.
Type: AssetModelStatus (p. 188) object
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 243).
ConflictingOperationException
Your request has conflicting operations. This can occur if you're trying to perform more than oneoperation on the same resource at the same time.
HTTP Status Code: 409InternalFailureException
AWS IoT SiteWise can't process your request right now. Try again later.
HTTP Status Code: 500InvalidRequestException
The request isn't valid. This can occur if your request contains malformed JSON or unsupportedcharacters. Check your request and try again.
HTTP Status Code: 400ResourceNotFoundException
The requested resource can't be found.
HTTP Status Code: 404ThrottlingException
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoTSiteWise assets that can be created per second, the allowed number of messages per second, and soon.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
HTTP Status Code: 429
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript
API Version 2019-12-0252
AWS IoT SiteWise API ReferenceSee Also
• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2019-12-0253
AWS IoT SiteWise API ReferenceDeleteDashboard
DeleteDashboardDeletes a dashboard from AWS IoT SiteWise Monitor.
Request SyntaxDELETE /dashboards/dashboardId?clientToken=clientToken HTTP/1.1
URI Request ParametersThe request requires the following URI parameters.
clientToken (p. 54)
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request.Don't reuse this client token if a new idempotent request is required.
Length Constraints: Minimum length of 36. Maximum length of 64.
Pattern: \S{36,64}dashboardId (p. 54)
The ID of the dashboard to delete.
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 204
Response ElementsIf the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 243).
InternalFailureException
AWS IoT SiteWise can't process your request right now. Try again later.
HTTP Status Code: 500InvalidRequestException
The request isn't valid. This can occur if your request contains malformed JSON or unsupportedcharacters. Check your request and try again.
API Version 2019-12-0254
AWS IoT SiteWise API ReferenceSee Also
HTTP Status Code: 400ResourceNotFoundException
The requested resource can't be found.
HTTP Status Code: 404ThrottlingException
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoTSiteWise assets that can be created per second, the allowed number of messages per second, and soon.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
HTTP Status Code: 429
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2019-12-0255
AWS IoT SiteWise API ReferenceDeleteGateway
DeleteGatewayDeletes a gateway from AWS IoT SiteWise. When you delete a gateway, some of the gateway's filesremain in your gateway's file system. For more information, see Data retention in the AWS IoT SiteWiseUser Guide.
Request SyntaxDELETE /20200301/gateways/gatewayId HTTP/1.1
URI Request ParametersThe request requires the following URI parameters.
gatewayId (p. 56)
The ID of the gateway to delete.
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 200
Response ElementsIf the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 243).
InternalFailureException
AWS IoT SiteWise can't process your request right now. Try again later.
HTTP Status Code: 500InvalidRequestException
The request isn't valid. This can occur if your request contains malformed JSON or unsupportedcharacters. Check your request and try again.
HTTP Status Code: 400ResourceNotFoundException
The requested resource can't be found.
API Version 2019-12-0256
AWS IoT SiteWise API ReferenceSee Also
HTTP Status Code: 404ThrottlingException
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoTSiteWise assets that can be created per second, the allowed number of messages per second, and soon.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
HTTP Status Code: 429
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2019-12-0257
AWS IoT SiteWise API ReferenceDeletePortal
DeletePortalDeletes a portal from AWS IoT SiteWise Monitor.
Request SyntaxDELETE /portals/portalId?clientToken=clientToken HTTP/1.1
URI Request ParametersThe request requires the following URI parameters.
clientToken (p. 58)
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request.Don't reuse this client token if a new idempotent request is required.
Length Constraints: Minimum length of 36. Maximum length of 64.
Pattern: \S{36,64}portalId (p. 58)
The ID of the portal to delete.
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 202Content-type: application/json
{ "portalStatus": { "error": { "code": "string", "message": "string" }, "state": "string" }}
Response ElementsIf the action is successful, the service sends back an HTTP 202 response.
The following data is returned in JSON format by the service.
API Version 2019-12-0258
AWS IoT SiteWise API ReferenceErrors
portalStatus (p. 58)
The status of the portal, which contains a state (DELETING after successfully calling this operation)and any error message.
Type: PortalStatus (p. 222) object
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 243).
ConflictingOperationException
Your request has conflicting operations. This can occur if you're trying to perform more than oneoperation on the same resource at the same time.
HTTP Status Code: 409InternalFailureException
AWS IoT SiteWise can't process your request right now. Try again later.
HTTP Status Code: 500InvalidRequestException
The request isn't valid. This can occur if your request contains malformed JSON or unsupportedcharacters. Check your request and try again.
HTTP Status Code: 400ResourceNotFoundException
The requested resource can't be found.
HTTP Status Code: 404ThrottlingException
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoTSiteWise assets that can be created per second, the allowed number of messages per second, and soon.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
HTTP Status Code: 429
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3
API Version 2019-12-0259
AWS IoT SiteWise API ReferenceSee Also
• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2019-12-0260
AWS IoT SiteWise API ReferenceDeleteProject
DeleteProjectDeletes a project from AWS IoT SiteWise Monitor.
Request SyntaxDELETE /projects/projectId?clientToken=clientToken HTTP/1.1
URI Request ParametersThe request requires the following URI parameters.
clientToken (p. 61)
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request.Don't reuse this client token if a new idempotent request is required.
Length Constraints: Minimum length of 36. Maximum length of 64.
Pattern: \S{36,64}projectId (p. 61)
The ID of the project.
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 204
Response ElementsIf the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 243).
InternalFailureException
AWS IoT SiteWise can't process your request right now. Try again later.
HTTP Status Code: 500InvalidRequestException
The request isn't valid. This can occur if your request contains malformed JSON or unsupportedcharacters. Check your request and try again.
API Version 2019-12-0261
AWS IoT SiteWise API ReferenceSee Also
HTTP Status Code: 400ResourceNotFoundException
The requested resource can't be found.
HTTP Status Code: 404ThrottlingException
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoTSiteWise assets that can be created per second, the allowed number of messages per second, and soon.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
HTTP Status Code: 429
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2019-12-0262
AWS IoT SiteWise API ReferenceDescribeAccessPolicy
DescribeAccessPolicyDescribes an access policy, which specifies an AWS SSO user or group's access to an AWS IoT SiteWiseMonitor portal or project.
Request Syntax
GET /access-policies/accessPolicyId HTTP/1.1
URI Request ParametersThe request requires the following URI parameters.
accessPolicyId (p. 63)
The ID of the access policy.
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Request BodyThe request does not have a request body.
Response Syntax
HTTP/1.1 200Content-type: application/json
{ "accessPolicyArn": "string", "accessPolicyCreationDate": number, "accessPolicyId": "string", "accessPolicyIdentity": { "group": { "id": "string" }, "user": { "id": "string" } }, "accessPolicyLastUpdateDate": number, "accessPolicyPermission": "string", "accessPolicyResource": { "portal": { "id": "string" }, "project": { "id": "string" } }}
API Version 2019-12-0263
AWS IoT SiteWise API ReferenceResponse Elements
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
accessPolicyArn (p. 63)
The ARN of the access policy, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:access-policy/${AccessPolicyId}
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
Pattern: .*accessPolicyCreationDate (p. 63)
The date the access policy was created, in Unix epoch time.
Type: TimestampaccessPolicyId (p. 63)
The ID of the access policy.
Type: String
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$accessPolicyIdentity (p. 63)
The AWS SSO identity (user or group) to which this access policy applies.
Type: Identity (p. 212) objectaccessPolicyLastUpdateDate (p. 63)
The date the access policy was last updated, in Unix epoch time.
Type: TimestampaccessPolicyPermission (p. 63)
The access policy permission. Note that a project ADMINISTRATOR is also known as a project owner.
Type: String
Valid Values: ADMINISTRATOR | VIEWERaccessPolicyResource (p. 63)
The AWS IoT SiteWise Monitor resource (portal or project) to which this access policy provides access.
Type: Resource (p. 234) object
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 243).
API Version 2019-12-0264
AWS IoT SiteWise API ReferenceSee Also
InternalFailureException
AWS IoT SiteWise can't process your request right now. Try again later.
HTTP Status Code: 500InvalidRequestException
The request isn't valid. This can occur if your request contains malformed JSON or unsupportedcharacters. Check your request and try again.
HTTP Status Code: 400ResourceNotFoundException
The requested resource can't be found.
HTTP Status Code: 404ThrottlingException
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoTSiteWise assets that can be created per second, the allowed number of messages per second, and soon.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
HTTP Status Code: 429
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2019-12-0265
AWS IoT SiteWise API ReferenceDescribeAsset
DescribeAssetRetrieves information about an asset.
Request SyntaxGET /assets/assetId HTTP/1.1
URI Request ParametersThe request requires the following URI parameters.
assetId (p. 66)
The ID of the asset.
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 200Content-type: application/json
{ "assetArn": "string", "assetCreationDate": number, "assetHierarchies": [ { "id": "string", "name": "string" } ], "assetId": "string", "assetLastUpdateDate": number, "assetModelId": "string", "assetName": "string", "assetProperties": [ { "alias": "string", "dataType": "string", "id": "string", "name": "string", "notification": { "state": "string", "topic": "string" }, "unit": "string" } ], "assetStatus": {
API Version 2019-12-0266
AWS IoT SiteWise API ReferenceResponse Elements
"error": { "code": "string", "message": "string" }, "state": "string" }}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
assetArn (p. 66)
The ARN of the asset, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
Pattern: .*assetCreationDate (p. 66)
The date the asset was created, in Unix epoch time.
Type: TimestampassetHierarchies (p. 66)
A list of asset hierarchies that each contain a hierarchyId. A hierarchy specifies allowed parent/child asset relationships.
Type: Array of AssetHierarchy (p. 181) objectsassetId (p. 66)
The ID of the asset.
Type: String
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$assetLastUpdateDate (p. 66)
The date the asset was last updated, in Unix epoch time.
Type: TimestampassetModelId (p. 66)
The ID of the asset model that was used to create the asset.
Type: String
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
API Version 2019-12-0267
AWS IoT SiteWise API ReferenceErrors
assetName (p. 66)
The name of the asset.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: [^\u0000-\u001F\u007F]+assetProperties (p. 66)
The list of asset properties for the asset.
Type: Array of AssetProperty (p. 191) objectsassetStatus (p. 66)
The current status of the asset, which contains a state and any error message.
Type: AssetStatus (p. 194) object
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 243).
InternalFailureException
AWS IoT SiteWise can't process your request right now. Try again later.
HTTP Status Code: 500InvalidRequestException
The request isn't valid. This can occur if your request contains malformed JSON or unsupportedcharacters. Check your request and try again.
HTTP Status Code: 400ResourceNotFoundException
The requested resource can't be found.
HTTP Status Code: 404ThrottlingException
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoTSiteWise assets that can be created per second, the allowed number of messages per second, and soon.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
HTTP Status Code: 429
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET
API Version 2019-12-0268
AWS IoT SiteWise API ReferenceSee Also
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2019-12-0269
AWS IoT SiteWise API ReferenceDescribeAssetModel
DescribeAssetModelRetrieves information about an asset model.
Request SyntaxGET /asset-models/assetModelId HTTP/1.1
URI Request ParametersThe request requires the following URI parameters.
assetModelId (p. 70)
The ID of the asset model.
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 200Content-type: application/json
{ "assetModelArn": "string", "assetModelCreationDate": number, "assetModelDescription": "string", "assetModelHierarchies": [ { "childAssetModelId": "string", "id": "string", "name": "string" } ], "assetModelId": "string", "assetModelLastUpdateDate": number, "assetModelName": "string", "assetModelProperties": [ { "dataType": "string", "id": "string", "name": "string", "type": { "attribute": { "defaultValue": "string" }, "measurement": { }, "metric": { "expression": "string",
API Version 2019-12-0270
AWS IoT SiteWise API ReferenceResponse Elements
"variables": [ { "name": "string", "value": { "hierarchyId": "string", "propertyId": "string" } } ], "window": { "tumbling": { "interval": "string" } } }, "transform": { "expression": "string", "variables": [ { "name": "string", "value": { "hierarchyId": "string", "propertyId": "string" } } ] } }, "unit": "string" } ], "assetModelStatus": { "error": { "code": "string", "message": "string" }, "state": "string" }}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
assetModelArn (p. 70)
The ARN of the asset model, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
Pattern: .*assetModelCreationDate (p. 70)
The date the asset model was created, in Unix epoch time.
Type: Timestamp
API Version 2019-12-0271
AWS IoT SiteWise API ReferenceErrors
assetModelDescription (p. 70)
The asset model's description.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: [^\u0000-\u001F\u007F]+assetModelHierarchies (p. 70)
A list of asset model hierarchies that each contain a childAssetModelId and a hierarchyId(named id). A hierarchy specifies allowed parent/child asset relationships for an asset model.
Type: Array of AssetModelHierarchy (p. 182) objectsassetModelId (p. 70)
The ID of the asset model.
Type: String
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$assetModelLastUpdateDate (p. 70)
The date the asset model was last updated, in Unix epoch time.
Type: TimestampassetModelName (p. 70)
The name of the asset model.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: [^\u0000-\u001F\u007F]+assetModelProperties (p. 70)
The list of asset properties for the asset model.
Type: Array of AssetModelProperty (p. 184) objectsassetModelStatus (p. 70)
The current status of the asset model, which contains a state and any error message.
Type: AssetModelStatus (p. 188) object
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 243).
InternalFailureException
AWS IoT SiteWise can't process your request right now. Try again later.
HTTP Status Code: 500
API Version 2019-12-0272
AWS IoT SiteWise API ReferenceSee Also
InvalidRequestException
The request isn't valid. This can occur if your request contains malformed JSON or unsupportedcharacters. Check your request and try again.
HTTP Status Code: 400ResourceNotFoundException
The requested resource can't be found.
HTTP Status Code: 404ThrottlingException
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoTSiteWise assets that can be created per second, the allowed number of messages per second, and soon.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
HTTP Status Code: 429
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2019-12-0273
AWS IoT SiteWise API ReferenceDescribeAssetProperty
DescribeAssetPropertyRetrieves information about an asset's property.
Request SyntaxGET /assets/assetId/properties/propertyId HTTP/1.1
URI Request ParametersThe request requires the following URI parameters.
assetId (p. 74)
The ID of the asset.
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$propertyId (p. 74)
The ID of the asset property.
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 200Content-type: application/json
{ "assetId": "string", "assetModelId": "string", "assetName": "string", "assetProperty": { "alias": "string", "dataType": "string", "id": "string", "name": "string", "notification": { "state": "string", "topic": "string" }, "type": { "attribute": { "defaultValue": "string" }, "measurement": { }, "metric": {
API Version 2019-12-0274
AWS IoT SiteWise API ReferenceResponse Elements
"expression": "string", "variables": [ { "name": "string", "value": { "hierarchyId": "string", "propertyId": "string" } } ], "window": { "tumbling": { "interval": "string" } } }, "transform": { "expression": "string", "variables": [ { "name": "string", "value": { "hierarchyId": "string", "propertyId": "string" } } ] } }, "unit": "string" }}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
assetId (p. 74)
The ID of the asset.
Type: String
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$assetModelId (p. 74)
The ID of the asset model.
Type: String
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$assetName (p. 74)
The name of the asset.
Type: String
API Version 2019-12-0275
AWS IoT SiteWise API ReferenceErrors
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: [^\u0000-\u001F\u007F]+assetProperty (p. 74)
The asset property's definition, alias, and notification state.
Type: Property (p. 228) object
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 243).
InternalFailureException
AWS IoT SiteWise can't process your request right now. Try again later.
HTTP Status Code: 500InvalidRequestException
The request isn't valid. This can occur if your request contains malformed JSON or unsupportedcharacters. Check your request and try again.
HTTP Status Code: 400ResourceNotFoundException
The requested resource can't be found.
HTTP Status Code: 404ThrottlingException
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoTSiteWise assets that can be created per second, the allowed number of messages per second, and soon.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
HTTP Status Code: 429
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2019-12-0276
AWS IoT SiteWise API ReferenceDescribeDashboard
DescribeDashboardRetrieves information about a dashboard.
Request SyntaxGET /dashboards/dashboardId HTTP/1.1
URI Request ParametersThe request requires the following URI parameters.
dashboardId (p. 77)
The ID of the dashboard.
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 200Content-type: application/json
{ "dashboardArn": "string", "dashboardCreationDate": number, "dashboardDefinition": "string", "dashboardDescription": "string", "dashboardId": "string", "dashboardLastUpdateDate": number, "dashboardName": "string", "projectId": "string"}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
dashboardArn (p. 77)
The ARN of the dashboard, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:dashboard/${DashboardId}
Type: String
API Version 2019-12-0277
AWS IoT SiteWise API ReferenceResponse Elements
Length Constraints: Minimum length of 1. Maximum length of 1600.
Pattern: .*dashboardCreationDate (p. 77)
The date the dashboard was created, in Unix epoch time.
Type: TimestampdashboardDefinition (p. 77)
The dashboard's definition JSON literal. For detailed information, see Creating Dashboards (CLI) inthe AWS IoT SiteWise User Guide.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 204800.
Pattern: .+dashboardDescription (p. 77)
The dashboard's description.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: [^\u0000-\u001F\u007F]+dashboardId (p. 77)
The ID of the dashboard.
Type: String
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$dashboardLastUpdateDate (p. 77)
The date the dashboard was last updated, in Unix epoch time.
Type: TimestampdashboardName (p. 77)
The name of the dashboard.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: [^\u0000-\u001F\u007F]+projectId (p. 77)
The ID of the project that the dashboard is in.
Type: String
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
API Version 2019-12-0278
AWS IoT SiteWise API ReferenceErrors
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 243).
InternalFailureException
AWS IoT SiteWise can't process your request right now. Try again later.
HTTP Status Code: 500InvalidRequestException
The request isn't valid. This can occur if your request contains malformed JSON or unsupportedcharacters. Check your request and try again.
HTTP Status Code: 400ResourceNotFoundException
The requested resource can't be found.
HTTP Status Code: 404ThrottlingException
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoTSiteWise assets that can be created per second, the allowed number of messages per second, and soon.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
HTTP Status Code: 429
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2019-12-0279
AWS IoT SiteWise API ReferenceDescribeGateway
DescribeGatewayRetrieves information about a gateway.
Request SyntaxGET /20200301/gateways/gatewayId HTTP/1.1
URI Request ParametersThe request requires the following URI parameters.
gatewayId (p. 80)
The ID of the gateway device.
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 200Content-type: application/json
{ "creationDate": number, "gatewayArn": "string", "gatewayCapabilitySummaries": [ { "capabilityNamespace": "string", "capabilitySyncStatus": "string" } ], "gatewayId": "string", "gatewayName": "string", "gatewayPlatform": { "greengrass": { "groupArn": "string" } }, "lastUpdateDate": number}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
API Version 2019-12-0280
AWS IoT SiteWise API ReferenceErrors
creationDate (p. 80)
The date the gateway was created, in Unix epoch time.
Type: TimestampgatewayArn (p. 80)
The ARN of the gateway, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:gateway/${GatewayId}
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
Pattern: .*gatewayCapabilitySummaries (p. 80)
A list of gateway capability summaries that each contain a namespace and status. Each gatewaycapability defines data sources for the gateway. To retrieve a capability configuration's definition,use DescribeGatewayCapabilityConfiguration.
Type: Array of GatewayCapabilitySummary (p. 206) objectsgatewayId (p. 80)
The ID of the gateway device.
Type: String
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$gatewayName (p. 80)
The name of the gateway.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: [^\u0000-\u001F\u007F]+gatewayPlatform (p. 80)
The gateway's platform.
Type: GatewayPlatform (p. 207) objectlastUpdateDate (p. 80)
The date the gateway was last updated, in Unix epoch time.
Type: Timestamp
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 243).
InternalFailureException
AWS IoT SiteWise can't process your request right now. Try again later.
API Version 2019-12-0281
AWS IoT SiteWise API ReferenceSee Also
HTTP Status Code: 500InvalidRequestException
The request isn't valid. This can occur if your request contains malformed JSON or unsupportedcharacters. Check your request and try again.
HTTP Status Code: 400ResourceNotFoundException
The requested resource can't be found.
HTTP Status Code: 404ThrottlingException
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoTSiteWise assets that can be created per second, the allowed number of messages per second, and soon.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
HTTP Status Code: 429
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2019-12-0282
AWS IoT SiteWise API ReferenceDescribeGatewayCapabilityConfiguration
DescribeGatewayCapabilityConfigurationRetrieves information about a gateway capability configuration. Each gateway capability defines datasources for a gateway. A capability configuration can contain multiple data source configurations.If you define OPC-UA sources for a gateway in the AWS IoT SiteWise console, all of your OPC-UAsources are stored in one capability configuration. To list all capability configurations for a gateway, useDescribeGateway.
Request SyntaxGET /20200301/gateways/gatewayId/capability/capabilityNamespace HTTP/1.1
URI Request ParametersThe request requires the following URI parameters.
capabilityNamespace (p. 83)
The namespace of the capability configuration. For example, if you configure OPC-UA sourcesfrom the AWS IoT SiteWise console, your OPC-UA capability configuration has the namespaceiotsitewise:opcuacollector:version, where version is a number such as 1.
Length Constraints: Minimum length of 1. Maximum length of 512.
Pattern: ^[a-zA-Z]+:[a-zA-Z]+:[0-9]+$gatewayId (p. 83)
The ID of the gateway that defines the capability configuration.
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 200Content-type: application/json
{ "capabilityConfiguration": "string", "capabilityNamespace": "string", "capabilitySyncStatus": "string", "gatewayId": "string"}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
API Version 2019-12-0283
AWS IoT SiteWise API ReferenceErrors
The following data is returned in JSON format by the service.
capabilityConfiguration (p. 83)
The JSON document that defines the gateway capability's configuration. For more information, seeConfiguring data sources (CLI) in the AWS IoT SiteWise User Guide.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 204800.capabilityNamespace (p. 83)
The namespace of the gateway capability.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 512.
Pattern: ^[a-zA-Z]+:[a-zA-Z]+:[0-9]+$capabilitySyncStatus (p. 83)
The synchronization status of the capability configuration. The sync status can be one of thefollowing:• IN_SYNC – The gateway is running the capability configuration.• OUT_OF_SYNC – The gateway hasn't received the capability configuration.• SYNC_FAILED – The gateway rejected the capability configuration.
Type: String
Valid Values: IN_SYNC | OUT_OF_SYNC | SYNC_FAILEDgatewayId (p. 83)
The ID of the gateway that defines the capability configuration.
Type: String
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 243).
InternalFailureException
AWS IoT SiteWise can't process your request right now. Try again later.
HTTP Status Code: 500InvalidRequestException
The request isn't valid. This can occur if your request contains malformed JSON or unsupportedcharacters. Check your request and try again.
HTTP Status Code: 400ResourceNotFoundException
The requested resource can't be found.
API Version 2019-12-0284
AWS IoT SiteWise API ReferenceSee Also
HTTP Status Code: 404ThrottlingException
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoTSiteWise assets that can be created per second, the allowed number of messages per second, and soon.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
HTTP Status Code: 429
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2019-12-0285
AWS IoT SiteWise API ReferenceDescribeLoggingOptions
DescribeLoggingOptionsRetrieves the current AWS IoT SiteWise logging options.
Request SyntaxGET /logging HTTP/1.1
URI Request ParametersThe request does not use any URI parameters.
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 200Content-type: application/json
{ "loggingOptions": { "level": "string" }}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
loggingOptions (p. 86)
The current logging options.
Type: LoggingOptions (p. 216) object
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 243).
InternalFailureException
AWS IoT SiteWise can't process your request right now. Try again later.
HTTP Status Code: 500InvalidRequestException
The request isn't valid. This can occur if your request contains malformed JSON or unsupportedcharacters. Check your request and try again.
API Version 2019-12-0286
AWS IoT SiteWise API ReferenceSee Also
HTTP Status Code: 400ResourceNotFoundException
The requested resource can't be found.
HTTP Status Code: 404ThrottlingException
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoTSiteWise assets that can be created per second, the allowed number of messages per second, and soon.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
HTTP Status Code: 429
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2019-12-0287
AWS IoT SiteWise API ReferenceDescribePortal
DescribePortalRetrieves information about a portal.
Request SyntaxGET /portals/portalId HTTP/1.1
URI Request ParametersThe request requires the following URI parameters.
portalId (p. 88)
The ID of the portal.
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 200Content-type: application/json
{ "portalArn": "string", "portalClientId": "string", "portalContactEmail": "string", "portalCreationDate": number, "portalDescription": "string", "portalId": "string", "portalLastUpdateDate": number, "portalLogoImageLocation": { "id": "string", "url": "string" }, "portalName": "string", "portalStartUrl": "string", "portalStatus": { "error": { "code": "string", "message": "string" }, "state": "string" }, "roleArn": "string"}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
API Version 2019-12-0288
AWS IoT SiteWise API ReferenceResponse Elements
The following data is returned in JSON format by the service.
portalArn (p. 88)
The ARN of the portal, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId}
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
Pattern: .*portalClientId (p. 88)
The AWS SSO application generated client ID (used with AWS SSO APIs).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: ^[!-~]*portalContactEmail (p. 88)
The AWS administrator's contact email address.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: [^@]+@[^@]+portalCreationDate (p. 88)
The date the portal was created, in Unix epoch time.
Type: TimestampportalDescription (p. 88)
The portal's description.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: [^\u0000-\u001F\u007F]+portalId (p. 88)
The ID of the portal.
Type: String
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$portalLastUpdateDate (p. 88)
The date the portal was last updated, in Unix epoch time.
Type: Timestamp
API Version 2019-12-0289
AWS IoT SiteWise API ReferenceErrors
portalLogoImageLocation (p. 88)
The portal's logo image, which is available at a URL.
Type: ImageLocation (p. 215) objectportalName (p. 88)
The name of the portal.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: [^\u0000-\u001F\u007F]+portalStartUrl (p. 88)
The public root URL for the AWS IoT AWS IoT SiteWise Monitor application portal.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: ^(http|https)\://\S+portalStatus (p. 88)
The current status of the portal, which contains a state and any error message.
Type: PortalStatus (p. 222) objectroleArn (p. 88)
The ARN of the service role that allows the portal's users to access your AWS IoT SiteWise resourceson your behalf. For more information, see Using service roles for AWS IoT SiteWise Monitor in theAWS IoT SiteWise User Guide.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
Pattern: .*
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 243).
InternalFailureException
AWS IoT SiteWise can't process your request right now. Try again later.
HTTP Status Code: 500InvalidRequestException
The request isn't valid. This can occur if your request contains malformed JSON or unsupportedcharacters. Check your request and try again.
HTTP Status Code: 400ResourceNotFoundException
The requested resource can't be found.
API Version 2019-12-0290
AWS IoT SiteWise API ReferenceSee Also
HTTP Status Code: 404ThrottlingException
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoTSiteWise assets that can be created per second, the allowed number of messages per second, and soon.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
HTTP Status Code: 429
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2019-12-0291
AWS IoT SiteWise API ReferenceDescribeProject
DescribeProjectRetrieves information about a project.
Request SyntaxGET /projects/projectId HTTP/1.1
URI Request ParametersThe request requires the following URI parameters.
projectId (p. 92)
The ID of the project.
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 200Content-type: application/json
{ "portalId": "string", "projectArn": "string", "projectCreationDate": number, "projectDescription": "string", "projectId": "string", "projectLastUpdateDate": number, "projectName": "string"}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
portalId (p. 92)
The ID of the portal that the project is in.
Type: String
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
API Version 2019-12-0292
AWS IoT SiteWise API ReferenceErrors
projectArn (p. 92)
The ARN of the project, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:project/${ProjectId}
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
Pattern: .*projectCreationDate (p. 92)
The date the project was created, in Unix epoch time.
Type: TimestampprojectDescription (p. 92)
The project's description.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: [^\u0000-\u001F\u007F]+projectId (p. 92)
The ID of the project.
Type: String
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$projectLastUpdateDate (p. 92)
The date the project was last updated, in Unix epoch time.
Type: TimestampprojectName (p. 92)
The name of the project.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: [^\u0000-\u001F\u007F]+
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 243).
InternalFailureException
AWS IoT SiteWise can't process your request right now. Try again later.
HTTP Status Code: 500
API Version 2019-12-0293
AWS IoT SiteWise API ReferenceSee Also
InvalidRequestException
The request isn't valid. This can occur if your request contains malformed JSON or unsupportedcharacters. Check your request and try again.
HTTP Status Code: 400ResourceNotFoundException
The requested resource can't be found.
HTTP Status Code: 404ThrottlingException
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoTSiteWise assets that can be created per second, the allowed number of messages per second, and soon.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
HTTP Status Code: 429
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2019-12-0294
AWS IoT SiteWise API ReferenceDisassociateAssets
DisassociateAssetsDisassociates a child asset from the given parent asset through a hierarchy defined in the parent asset'smodel.
Request SyntaxPOST /assets/assetId/disassociate HTTP/1.1Content-type: application/json
{ "childAssetId": "string", "clientToken": "string", "hierarchyId": "string"}
URI Request ParametersThe request requires the following URI parameters.
assetId (p. 95)
The ID of the parent asset from which to disassociate the child asset.
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Request BodyThe request accepts the following data in JSON format.
childAssetId (p. 95)
The ID of the child asset to disassociate.
Type: String
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Required: YesclientToken (p. 95)
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request.Don't reuse this client token if a new idempotent request is required.
Type: String
Length Constraints: Minimum length of 36. Maximum length of 64.
Pattern: \S{36,64}
Required: No
API Version 2019-12-0295
AWS IoT SiteWise API ReferenceResponse Syntax
hierarchyId (p. 95)
The ID of a hierarchy in the parent asset's model. Hierarchies allow different groupings of assets tobe formed that all come from the same asset model. You can use the hierarchy ID to identify thecorrect asset to disassociate. For more information, see Asset Hierarchies in the AWS IoT SiteWiseUser Guide.
Type: String
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Required: Yes
Response SyntaxHTTP/1.1 200
Response ElementsIf the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 243).
ConflictingOperationException
Your request has conflicting operations. This can occur if you're trying to perform more than oneoperation on the same resource at the same time.
HTTP Status Code: 409InternalFailureException
AWS IoT SiteWise can't process your request right now. Try again later.
HTTP Status Code: 500InvalidRequestException
The request isn't valid. This can occur if your request contains malformed JSON or unsupportedcharacters. Check your request and try again.
HTTP Status Code: 400ResourceNotFoundException
The requested resource can't be found.
HTTP Status Code: 404ThrottlingException
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoTSiteWise assets that can be created per second, the allowed number of messages per second, and soon.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
API Version 2019-12-0296
AWS IoT SiteWise API ReferenceSee Also
HTTP Status Code: 429
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2019-12-0297
AWS IoT SiteWise API ReferenceGetAssetPropertyAggregates
GetAssetPropertyAggregatesGets aggregated values for an asset property. For more information, see Querying Aggregated PropertyValues in the AWS IoT SiteWise User Guide.
To identify an asset property, you must specify one of the following:
• The assetId and propertyId of an asset property.
• A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.
Request SyntaxGET /properties/aggregates?aggregateTypes=aggregateTypes&assetId=assetId&endDate=endDate&maxResults=maxResults&nextToken=nextToken&propertyAlias=propertyAlias&propertyId=propertyId&qualities=qualities&resolution=resolution&startDate=startDate&timeOrdering=timeOrdering HTTP/1.1
URI Request ParametersThe request requires the following URI parameters.
aggregateTypes (p. 98)
The data aggregating function.
Array Members: Minimum number of 1 item.
Valid Values: AVERAGE | COUNT | MAXIMUM | MINIMUM | SUM | STANDARD_DEVIATION
assetId (p. 98)
The ID of the asset.
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
endDate (p. 98)
The inclusive end of the range from which to query historical data, expressed in seconds in Unixepoch time.
maxResults (p. 98)
The maximum number of results to be returned per paginated request.
Default: 100
Valid Range: Minimum value of 1. Maximum value of 250.
nextToken (p. 98)
The token to be used for the next set of paginated results.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: [A-Za-z0-9+/=]+
API Version 2019-12-0298
AWS IoT SiteWise API ReferenceRequest Body
propertyAlias (p. 98)
The property alias that identifies the property, such as an OPC-UA server data stream path (forexample, /company/windfarm/3/turbine/7/temperature). For more information, seeMapping Industrial Data Streams to Asset Properties in the AWS IoT SiteWise User Guide.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: [^\u0000-\u001F\u007F]+propertyId (p. 98)
The ID of the asset property.
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$qualities (p. 98)
The quality by which to filter asset data.
Array Members: Fixed number of 1 item.
Valid Values: GOOD | BAD | UNCERTAINresolution (p. 98)
The time interval over which to aggregate data.
Length Constraints: Fixed length of 2.
Pattern: 1m|1h|1dstartDate (p. 98)
The exclusive start of the range from which to query historical data, expressed in seconds in Unixepoch time.
timeOrdering (p. 98)
The chronological sorting order of the requested information.
Default: ASCENDING
Valid Values: ASCENDING | DESCENDING
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 200Content-type: application/json
{ "aggregatedValues": [ { "quality": "string", "timestamp": number, "value": {
API Version 2019-12-0299
AWS IoT SiteWise API ReferenceResponse Elements
"average": number, "count": number, "maximum": number, "minimum": number, "standardDeviation": number, "sum": number } } ], "nextToken": "string"}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
aggregatedValues (p. 99)
The requested aggregated values.
Type: Array of AggregatedValue (p. 177) objectsnextToken (p. 99)
The token for the next set of results, or null if there are no additional results.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: [A-Za-z0-9+/=]+
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 243).
InternalFailureException
AWS IoT SiteWise can't process your request right now. Try again later.
HTTP Status Code: 500InvalidRequestException
The request isn't valid. This can occur if your request contains malformed JSON or unsupportedcharacters. Check your request and try again.
HTTP Status Code: 400ResourceNotFoundException
The requested resource can't be found.
HTTP Status Code: 404ServiceUnavailableException
The requested service is unavailable.
HTTP Status Code: 503
API Version 2019-12-02100
AWS IoT SiteWise API ReferenceSee Also
ThrottlingException
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoTSiteWise assets that can be created per second, the allowed number of messages per second, and soon.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
HTTP Status Code: 429
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2019-12-02101
AWS IoT SiteWise API ReferenceGetAssetPropertyValue
GetAssetPropertyValueGets an asset property's current value. For more information, see Querying Current Property Values inthe AWS IoT SiteWise User Guide.
To identify an asset property, you must specify one of the following:
• The assetId and propertyId of an asset property.• A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.
Request SyntaxGET /properties/latest?assetId=assetId&propertyAlias=propertyAlias&propertyId=propertyId HTTP/1.1
URI Request ParametersThe request requires the following URI parameters.
assetId (p. 102)
The ID of the asset.
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$propertyAlias (p. 102)
The property alias that identifies the property, such as an OPC-UA server data stream path (forexample, /company/windfarm/3/turbine/7/temperature). For more information, seeMapping Industrial Data Streams to Asset Properties in the AWS IoT SiteWise User Guide.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: [^\u0000-\u001F\u007F]+propertyId (p. 102)
The ID of the asset property.
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 200Content-type: application/json
API Version 2019-12-02102
AWS IoT SiteWise API ReferenceResponse Elements
{ "propertyValue": { "quality": "string", "timestamp": { "offsetInNanos": number, "timeInSeconds": number }, "value": { "booleanValue": boolean, "doubleValue": number, "integerValue": number, "stringValue": "string" } }}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
propertyValue (p. 102)
The current asset property value.
Type: AssetPropertyValue (p. 193) object
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 243).
InternalFailureException
AWS IoT SiteWise can't process your request right now. Try again later.
HTTP Status Code: 500InvalidRequestException
The request isn't valid. This can occur if your request contains malformed JSON or unsupportedcharacters. Check your request and try again.
HTTP Status Code: 400ResourceNotFoundException
The requested resource can't be found.
HTTP Status Code: 404ServiceUnavailableException
The requested service is unavailable.
HTTP Status Code: 503ThrottlingException
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoTSiteWise assets that can be created per second, the allowed number of messages per second, and soon.
API Version 2019-12-02103
AWS IoT SiteWise API ReferenceSee Also
For more information, see Quotas in the AWS IoT SiteWise User Guide.
HTTP Status Code: 429
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2019-12-02104
AWS IoT SiteWise API ReferenceGetAssetPropertyValueHistory
GetAssetPropertyValueHistoryGets the history of an asset property's values. For more information, see Querying Historical PropertyValues in the AWS IoT SiteWise User Guide.
To identify an asset property, you must specify one of the following:
• The assetId and propertyId of an asset property.• A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.
Request SyntaxGET /properties/history?assetId=assetId&endDate=endDate&maxResults=maxResults&nextToken=nextToken&propertyAlias=propertyAlias&propertyId=propertyId&qualities=qualities&startDate=startDate&timeOrdering=timeOrdering HTTP/1.1
URI Request ParametersThe request requires the following URI parameters.
assetId (p. 105)
The ID of the asset.
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$endDate (p. 105)
The inclusive end of the range from which to query historical data, expressed in seconds in Unixepoch time.
maxResults (p. 105)
The maximum number of results to be returned per paginated request.
Default: 100
Valid Range: Minimum value of 1. Maximum value of 250.nextToken (p. 105)
The token to be used for the next set of paginated results.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: [A-Za-z0-9+/=]+propertyAlias (p. 105)
The property alias that identifies the property, such as an OPC-UA server data stream path (forexample, /company/windfarm/3/turbine/7/temperature). For more information, seeMapping Industrial Data Streams to Asset Properties in the AWS IoT SiteWise User Guide.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: [^\u0000-\u001F\u007F]+
API Version 2019-12-02105
AWS IoT SiteWise API ReferenceRequest Body
propertyId (p. 105)
The ID of the asset property.
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$qualities (p. 105)
The quality by which to filter asset data.
Array Members: Fixed number of 1 item.
Valid Values: GOOD | BAD | UNCERTAINstartDate (p. 105)
The exclusive start of the range from which to query historical data, expressed in seconds in Unixepoch time.
timeOrdering (p. 105)
The chronological sorting order of the requested information.
Default: ASCENDING
Valid Values: ASCENDING | DESCENDING
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 200Content-type: application/json
{ "assetPropertyValueHistory": [ { "quality": "string", "timestamp": { "offsetInNanos": number, "timeInSeconds": number }, "value": { "booleanValue": boolean, "doubleValue": number, "integerValue": number, "stringValue": "string" } } ], "nextToken": "string"}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
API Version 2019-12-02106
AWS IoT SiteWise API ReferenceErrors
The following data is returned in JSON format by the service.
assetPropertyValueHistory (p. 106)
The asset property's value history.
Type: Array of AssetPropertyValue (p. 193) objectsnextToken (p. 106)
The token for the next set of results, or null if there are no additional results.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: [A-Za-z0-9+/=]+
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 243).
InternalFailureException
AWS IoT SiteWise can't process your request right now. Try again later.
HTTP Status Code: 500InvalidRequestException
The request isn't valid. This can occur if your request contains malformed JSON or unsupportedcharacters. Check your request and try again.
HTTP Status Code: 400ResourceNotFoundException
The requested resource can't be found.
HTTP Status Code: 404ServiceUnavailableException
The requested service is unavailable.
HTTP Status Code: 503ThrottlingException
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoTSiteWise assets that can be created per second, the allowed number of messages per second, and soon.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
HTTP Status Code: 429
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
API Version 2019-12-02107
AWS IoT SiteWise API ReferenceSee Also
• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2019-12-02108
AWS IoT SiteWise API ReferenceListAccessPolicies
ListAccessPoliciesRetrieves a paginated list of access policies for an AWS SSO identity (a user or group) or an AWS IoTSiteWise Monitor resource (a portal or project).
Request SyntaxGET /access-policies?identityId=identityId&identityType=identityType&maxResults=maxResults&nextToken=nextToken&resourceId=resourceId&resourceType=resourceType HTTP/1.1
URI Request ParametersThe request requires the following URI parameters.
identityId (p. 109)
The ID of the identity. This parameter is required if you specify identityType.
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: \S+identityType (p. 109)
The type of identity (user or group). This parameter is required if you specify identityId.
Valid Values: USER | GROUPmaxResults (p. 109)
The maximum number of results to be returned per paginated request.
Default: 50
Valid Range: Minimum value of 1. Maximum value of 250.nextToken (p. 109)
The token to be used for the next set of paginated results.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: [A-Za-z0-9+/=]+resourceId (p. 109)
The ID of the resource. This parameter is required if you specify resourceType.
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$resourceType (p. 109)
The type of resource (portal or project). This parameter is required if you specify resourceId.
Valid Values: PORTAL | PROJECT
Request BodyThe request does not have a request body.
API Version 2019-12-02109
AWS IoT SiteWise API ReferenceResponse Syntax
Response Syntax
HTTP/1.1 200Content-type: application/json
{ "accessPolicySummaries": [ { "creationDate": number, "id": "string", "identity": { "group": { "id": "string" }, "user": { "id": "string" } }, "lastUpdateDate": number, "permission": "string", "resource": { "portal": { "id": "string" }, "project": { "id": "string" } } } ], "nextToken": "string"}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
accessPolicySummaries (p. 110)
A list that summarizes each access policy.
Type: Array of AccessPolicySummary (p. 175) objects
nextToken (p. 110)
The token for the next set of results, or null if there are no additional results.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: [A-Za-z0-9+/=]+
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 243).
API Version 2019-12-02110
AWS IoT SiteWise API ReferenceSee Also
InternalFailureException
AWS IoT SiteWise can't process your request right now. Try again later.
HTTP Status Code: 500InvalidRequestException
The request isn't valid. This can occur if your request contains malformed JSON or unsupportedcharacters. Check your request and try again.
HTTP Status Code: 400ThrottlingException
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoTSiteWise assets that can be created per second, the allowed number of messages per second, and soon.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
HTTP Status Code: 429
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2019-12-02111
AWS IoT SiteWise API ReferenceListAssetModels
ListAssetModelsRetrieves a paginated list of summaries of all asset models.
Request SyntaxGET /asset-models?maxResults=maxResults&nextToken=nextToken HTTP/1.1
URI Request ParametersThe request requires the following URI parameters.
maxResults (p. 112)
The maximum number of results to be returned per paginated request.
Default: 50
Valid Range: Minimum value of 1. Maximum value of 250.nextToken (p. 112)
The token to be used for the next set of paginated results.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: [A-Za-z0-9+/=]+
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 200Content-type: application/json
{ "assetModelSummaries": [ { "arn": "string", "creationDate": number, "description": "string", "id": "string", "lastUpdateDate": number, "name": "string", "status": { "error": { "code": "string", "message": "string" }, "state": "string" } } ], "nextToken": "string"
API Version 2019-12-02112
AWS IoT SiteWise API ReferenceResponse Elements
}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
assetModelSummaries (p. 112)
A list that summarizes each asset model.
Type: Array of AssetModelSummary (p. 189) objectsnextToken (p. 112)
The token for the next set of results, or null if there are no additional results.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: [A-Za-z0-9+/=]+
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 243).
InternalFailureException
AWS IoT SiteWise can't process your request right now. Try again later.
HTTP Status Code: 500InvalidRequestException
The request isn't valid. This can occur if your request contains malformed JSON or unsupportedcharacters. Check your request and try again.
HTTP Status Code: 400ThrottlingException
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoTSiteWise assets that can be created per second, the allowed number of messages per second, and soon.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
HTTP Status Code: 429
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++
API Version 2019-12-02113
AWS IoT SiteWise API ReferenceSee Also
• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2019-12-02114
AWS IoT SiteWise API ReferenceListAssets
ListAssetsRetrieves a paginated list of asset summaries.
You can use this operation to do the following:
• List assets based on a specific asset model.
• List top-level assets.
You can't use this operation to list all assets. To retrieve summaries for all of your assets, useListAssetModels to get all of your asset model IDs. Then, use ListAssets to get all assets for each assetmodel.
Request Syntax
GET /assets?assetModelId=assetModelId&filter=filter&maxResults=maxResults&nextToken=nextToken HTTP/1.1
URI Request ParametersThe request requires the following URI parameters.
assetModelId (p. 115)
The ID of the asset model by which to filter the list of assets. This parameter is required if youchoose ALL for filter.
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
filter (p. 115)
The filter for the requested list of assets. Choose one of the following options:
• ALL – The list includes all assets for a given asset model ID. The assetModelId parameter isrequired if you filter by ALL.
• TOP_LEVEL – The list includes only top-level assets in the asset hierarchy tree.
Default: ALL
Valid Values: ALL | TOP_LEVEL
maxResults (p. 115)
The maximum number of results to be returned per paginated request.
Default: 50
Valid Range: Minimum value of 1. Maximum value of 250.
nextToken (p. 115)
The token to be used for the next set of paginated results.
Length Constraints: Minimum length of 1. Maximum length of 2048.
API Version 2019-12-02115
AWS IoT SiteWise API ReferenceRequest Body
Pattern: [A-Za-z0-9+/=]+
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 200Content-type: application/json
{ "assetSummaries": [ { "arn": "string", "assetModelId": "string", "creationDate": number, "hierarchies": [ { "id": "string", "name": "string" } ], "id": "string", "lastUpdateDate": number, "name": "string", "status": { "error": { "code": "string", "message": "string" }, "state": "string" } } ], "nextToken": "string"}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
assetSummaries (p. 116)
A list that summarizes each asset.
Type: Array of AssetSummary (p. 195) objectsnextToken (p. 116)
The token for the next set of results, or null if there are no additional results.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: [A-Za-z0-9+/=]+
API Version 2019-12-02116
AWS IoT SiteWise API ReferenceErrors
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 243).
InternalFailureException
AWS IoT SiteWise can't process your request right now. Try again later.
HTTP Status Code: 500InvalidRequestException
The request isn't valid. This can occur if your request contains malformed JSON or unsupportedcharacters. Check your request and try again.
HTTP Status Code: 400ResourceNotFoundException
The requested resource can't be found.
HTTP Status Code: 404ThrottlingException
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoTSiteWise assets that can be created per second, the allowed number of messages per second, and soon.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
HTTP Status Code: 429
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2019-12-02117
AWS IoT SiteWise API ReferenceListAssociatedAssets
ListAssociatedAssetsRetrieves a paginated list of the assets associated to a parent asset (assetId) by a given hierarchy(hierarchyId).
Request SyntaxGET /assets/assetId/hierarchies?hierarchyId=hierarchyId&maxResults=maxResults&nextToken=nextToken HTTP/1.1
URI Request ParametersThe request requires the following URI parameters.
assetId (p. 118)
The ID of the parent asset.
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$hierarchyId (p. 118)
The hierarchy ID (of the parent asset model) whose associated assets are returned. To find ahierarchy ID, use the DescribeAsset or DescribeAssetModel actions.
For more information, see Asset Hierarchies in the AWS IoT SiteWise User Guide.
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$maxResults (p. 118)
The maximum number of results to be returned per paginated request.
Default: 50
Valid Range: Minimum value of 1. Maximum value of 250.nextToken (p. 118)
The token to be used for the next set of paginated results.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: [A-Za-z0-9+/=]+
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 200
API Version 2019-12-02118
AWS IoT SiteWise API ReferenceResponse Elements
Content-type: application/json
{ "assetSummaries": [ { "arn": "string", "assetModelId": "string", "creationDate": number, "hierarchies": [ { "id": "string", "name": "string" } ], "id": "string", "lastUpdateDate": number, "name": "string", "status": { "error": { "code": "string", "message": "string" }, "state": "string" } } ], "nextToken": "string"}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
assetSummaries (p. 118)
A list that summarizes the associated assets.
Type: Array of AssociatedAssetsSummary (p. 197) objects
nextToken (p. 118)
The token for the next set of results, or null if there are no additional results.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: [A-Za-z0-9+/=]+
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 243).
InternalFailureException
AWS IoT SiteWise can't process your request right now. Try again later.
HTTP Status Code: 500
API Version 2019-12-02119
AWS IoT SiteWise API ReferenceSee Also
InvalidRequestException
The request isn't valid. This can occur if your request contains malformed JSON or unsupportedcharacters. Check your request and try again.
HTTP Status Code: 400ResourceNotFoundException
The requested resource can't be found.
HTTP Status Code: 404ThrottlingException
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoTSiteWise assets that can be created per second, the allowed number of messages per second, and soon.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
HTTP Status Code: 429
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2019-12-02120
AWS IoT SiteWise API ReferenceListDashboards
ListDashboardsRetrieves a paginated list of dashboards for an AWS IoT SiteWise Monitor project.
Request SyntaxGET /dashboards?maxResults=maxResults&nextToken=nextToken&projectId=projectId HTTP/1.1
URI Request ParametersThe request requires the following URI parameters.
maxResults (p. 121)
The maximum number of results to be returned per paginated request.
Default: 50
Valid Range: Minimum value of 1. Maximum value of 250.nextToken (p. 121)
The token to be used for the next set of paginated results.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: [A-Za-z0-9+/=]+projectId (p. 121)
The ID of the project.
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 200Content-type: application/json
{ "dashboardSummaries": [ { "creationDate": number, "description": "string", "id": "string", "lastUpdateDate": number, "name": "string" } ], "nextToken": "string"
API Version 2019-12-02121
AWS IoT SiteWise API ReferenceResponse Elements
}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
dashboardSummaries (p. 121)
A list that summarizes each dashboard in the project.
Type: Array of DashboardSummary (p. 202) objectsnextToken (p. 121)
The token for the next set of results, or null if there are no additional results.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: [A-Za-z0-9+/=]+
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 243).
InternalFailureException
AWS IoT SiteWise can't process your request right now. Try again later.
HTTP Status Code: 500InvalidRequestException
The request isn't valid. This can occur if your request contains malformed JSON or unsupportedcharacters. Check your request and try again.
HTTP Status Code: 400ThrottlingException
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoTSiteWise assets that can be created per second, the allowed number of messages per second, and soon.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
HTTP Status Code: 429
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++
API Version 2019-12-02122
AWS IoT SiteWise API ReferenceSee Also
• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2019-12-02123
AWS IoT SiteWise API ReferenceListGateways
ListGatewaysRetrieves a paginated list of gateways.
Request Syntax
GET /20200301/gateways?maxResults=maxResults&nextToken=nextToken HTTP/1.1
URI Request ParametersThe request requires the following URI parameters.
maxResults (p. 124)
The maximum number of results to be returned per paginated request.
Default: 50
Valid Range: Minimum value of 1. Maximum value of 250.
nextToken (p. 124)
The token to be used for the next set of paginated results.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: [A-Za-z0-9+/=]+
Request BodyThe request does not have a request body.
Response Syntax
HTTP/1.1 200Content-type: application/json
{ "gatewaySummaries": [ { "creationDate": number, "gatewayCapabilitySummaries": [ { "capabilityNamespace": "string", "capabilitySyncStatus": "string" } ], "gatewayId": "string", "gatewayName": "string", "lastUpdateDate": number } ], "nextToken": "string"}
API Version 2019-12-02124
AWS IoT SiteWise API ReferenceResponse Elements
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
gatewaySummaries (p. 124)
A list that summarizes each gateway.
Type: Array of GatewaySummary (p. 208) objectsnextToken (p. 124)
The token for the next set of results, or null if there are no additional results.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: [A-Za-z0-9+/=]+
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 243).
InternalFailureException
AWS IoT SiteWise can't process your request right now. Try again later.
HTTP Status Code: 500InvalidRequestException
The request isn't valid. This can occur if your request contains malformed JSON or unsupportedcharacters. Check your request and try again.
HTTP Status Code: 400ThrottlingException
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoTSiteWise assets that can be created per second, the allowed number of messages per second, and soon.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
HTTP Status Code: 429
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java
API Version 2019-12-02125
AWS IoT SiteWise API ReferenceSee Also
• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2019-12-02126
AWS IoT SiteWise API ReferenceListPortals
ListPortalsRetrieves a paginated list of AWS IoT SiteWise Monitor portals.
Request SyntaxGET /portals?maxResults=maxResults&nextToken=nextToken HTTP/1.1
URI Request ParametersThe request requires the following URI parameters.
maxResults (p. 127)
The maximum number of results to be returned per paginated request.
Default: 50
Valid Range: Minimum value of 1. Maximum value of 250.nextToken (p. 127)
The token to be used for the next set of paginated results.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: [A-Za-z0-9+/=]+
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 200Content-type: application/json
{ "nextToken": "string", "portalSummaries": [ { "creationDate": number, "description": "string", "id": "string", "lastUpdateDate": number, "name": "string", "roleArn": "string", "startUrl": "string" } ]}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
API Version 2019-12-02127
AWS IoT SiteWise API ReferenceErrors
The following data is returned in JSON format by the service.
nextToken (p. 127)
The token for the next set of results, or null if there are no additional results.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: [A-Za-z0-9+/=]+portalSummaries (p. 127)
A list that summarizes each portal.
Type: Array of PortalSummary (p. 223) objects
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 243).
InternalFailureException
AWS IoT SiteWise can't process your request right now. Try again later.
HTTP Status Code: 500InvalidRequestException
The request isn't valid. This can occur if your request contains malformed JSON or unsupportedcharacters. Check your request and try again.
HTTP Status Code: 400ThrottlingException
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoTSiteWise assets that can be created per second, the allowed number of messages per second, and soon.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
HTTP Status Code: 429
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python
API Version 2019-12-02128
AWS IoT SiteWise API ReferenceSee Also
• AWS SDK for Ruby V3
API Version 2019-12-02129
AWS IoT SiteWise API ReferenceListProjectAssets
ListProjectAssetsRetrieves a paginated list of assets associated with an AWS IoT SiteWise Monitor project.
Request SyntaxGET /projects/projectId/assets?maxResults=maxResults&nextToken=nextToken HTTP/1.1
URI Request ParametersThe request requires the following URI parameters.
maxResults (p. 130)
The maximum number of results to be returned per paginated request.
Default: 50
Valid Range: Minimum value of 1. Maximum value of 250.nextToken (p. 130)
The token to be used for the next set of paginated results.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: [A-Za-z0-9+/=]+projectId (p. 130)
The ID of the project.
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 200Content-type: application/json
{ "assetIds": [ "string" ], "nextToken": "string"}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
API Version 2019-12-02130
AWS IoT SiteWise API ReferenceErrors
assetIds (p. 130)
A list that contains the IDs of each asset associated with the project.
Type: Array of strings
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$nextToken (p. 130)
The token for the next set of results, or null if there are no additional results.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: [A-Za-z0-9+/=]+
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 243).
InternalFailureException
AWS IoT SiteWise can't process your request right now. Try again later.
HTTP Status Code: 500InvalidRequestException
The request isn't valid. This can occur if your request contains malformed JSON or unsupportedcharacters. Check your request and try again.
HTTP Status Code: 400ThrottlingException
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoTSiteWise assets that can be created per second, the allowed number of messages per second, and soon.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
HTTP Status Code: 429
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3
API Version 2019-12-02131
AWS IoT SiteWise API ReferenceSee Also
• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2019-12-02132
AWS IoT SiteWise API ReferenceListProjects
ListProjectsRetrieves a paginated list of projects for an AWS IoT SiteWise Monitor portal.
Request SyntaxGET /projects?maxResults=maxResults&nextToken=nextToken&portalId=portalId HTTP/1.1
URI Request ParametersThe request requires the following URI parameters.
maxResults (p. 133)
The maximum number of results to be returned per paginated request.
Default: 50
Valid Range: Minimum value of 1. Maximum value of 250.nextToken (p. 133)
The token to be used for the next set of paginated results.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: [A-Za-z0-9+/=]+portalId (p. 133)
The ID of the portal.
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 200Content-type: application/json
{ "nextToken": "string", "projectSummaries": [ { "creationDate": number, "description": "string", "id": "string", "lastUpdateDate": number, "name": "string" } ]
API Version 2019-12-02133
AWS IoT SiteWise API ReferenceResponse Elements
}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
nextToken (p. 133)
The token for the next set of results, or null if there are no additional results.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: [A-Za-z0-9+/=]+projectSummaries (p. 133)
A list that summarizes each project in the portal.
Type: Array of ProjectSummary (p. 226) objects
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 243).
InternalFailureException
AWS IoT SiteWise can't process your request right now. Try again later.
HTTP Status Code: 500InvalidRequestException
The request isn't valid. This can occur if your request contains malformed JSON or unsupportedcharacters. Check your request and try again.
HTTP Status Code: 400ThrottlingException
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoTSiteWise assets that can be created per second, the allowed number of messages per second, and soon.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
HTTP Status Code: 429
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++
API Version 2019-12-02134
AWS IoT SiteWise API ReferenceSee Also
• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2019-12-02135
AWS IoT SiteWise API ReferenceListTagsForResource
ListTagsForResourceRetrieves the list of tags for an AWS IoT SiteWise resource.
Request SyntaxGET /tags?resourceArn=resourceArn HTTP/1.1
URI Request ParametersThe request requires the following URI parameters.
resourceArn (p. 136)
The ARN of the resource.
Length Constraints: Minimum length of 1. Maximum length of 1011.
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 200Content-type: application/json
{ "tags": { "string" : "string" }}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
tags (p. 136)
The list of key-value pairs that contain metadata for the resource. For more information, see Taggingyour AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide.
Type: String to string map
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Value Length Constraints: Minimum length of 0. Maximum length of 256.
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 243).
API Version 2019-12-02136
AWS IoT SiteWise API ReferenceSee Also
InternalFailureException
AWS IoT SiteWise can't process your request right now. Try again later.
HTTP Status Code: 500InvalidRequestException
The request isn't valid. This can occur if your request contains malformed JSON or unsupportedcharacters. Check your request and try again.
HTTP Status Code: 400ResourceNotFoundException
The requested resource can't be found.
HTTP Status Code: 404ThrottlingException
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoTSiteWise assets that can be created per second, the allowed number of messages per second, and soon.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
HTTP Status Code: 429
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2019-12-02137
AWS IoT SiteWise API ReferencePutLoggingOptions
PutLoggingOptionsSets logging options for AWS IoT SiteWise.
Request SyntaxPUT /logging HTTP/1.1Content-type: application/json
{ "loggingOptions": { "level": "string" }}
URI Request ParametersThe request does not use any URI parameters.
Request BodyThe request accepts the following data in JSON format.
loggingOptions (p. 138)
The logging options to set.
Type: LoggingOptions (p. 216) object
Required: Yes
Response SyntaxHTTP/1.1 200
Response ElementsIf the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 243).
ConflictingOperationException
Your request has conflicting operations. This can occur if you're trying to perform more than oneoperation on the same resource at the same time.
HTTP Status Code: 409InternalFailureException
AWS IoT SiteWise can't process your request right now. Try again later.
API Version 2019-12-02138
AWS IoT SiteWise API ReferenceSee Also
HTTP Status Code: 500InvalidRequestException
The request isn't valid. This can occur if your request contains malformed JSON or unsupportedcharacters. Check your request and try again.
HTTP Status Code: 400ResourceNotFoundException
The requested resource can't be found.
HTTP Status Code: 404ThrottlingException
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoTSiteWise assets that can be created per second, the allowed number of messages per second, and soon.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
HTTP Status Code: 429
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2019-12-02139
AWS IoT SiteWise API ReferenceTagResource
TagResourceAdds tags to an AWS IoT SiteWise resource. If a tag already exists for the resource, this operation updatesthe tag's value.
Request Syntax
POST /tags?resourceArn=resourceArn HTTP/1.1Content-type: application/json
{ "tags": { "string" : "string" }}
URI Request ParametersThe request requires the following URI parameters.
resourceArn (p. 140)
The ARN of the resource to tag.
Length Constraints: Minimum length of 1. Maximum length of 1011.
Request BodyThe request accepts the following data in JSON format.
tags (p. 140)
A list of key-value pairs that contain metadata for the resource. For more information, see Taggingyour AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide.
Type: String to string map
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Value Length Constraints: Minimum length of 0. Maximum length of 256.
Required: Yes
Response Syntax
HTTP/1.1 200
Response ElementsIf the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
API Version 2019-12-02140
AWS IoT SiteWise API ReferenceErrors
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 243).
InternalFailureException
AWS IoT SiteWise can't process your request right now. Try again later.
HTTP Status Code: 500InvalidRequestException
The request isn't valid. This can occur if your request contains malformed JSON or unsupportedcharacters. Check your request and try again.
HTTP Status Code: 400ResourceNotFoundException
The requested resource can't be found.
HTTP Status Code: 404ThrottlingException
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoTSiteWise assets that can be created per second, the allowed number of messages per second, and soon.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
HTTP Status Code: 429TooManyTagsException
You've reached the limit for the number of tags allowed for a resource. For more information, seeTag naming limits and requirements in the AWS General Reference.
HTTP Status Code: 400
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2019-12-02141
AWS IoT SiteWise API ReferenceUntagResource
UntagResourceRemoves a tag from an AWS IoT SiteWise resource.
Request SyntaxDELETE /tags?resourceArn=resourceArn&tagKeys=tagKeys HTTP/1.1
URI Request ParametersThe request requires the following URI parameters.
resourceArn (p. 142)
The ARN of the resource to untag.
Length Constraints: Minimum length of 1. Maximum length of 1011.tagKeys (p. 142)
A list of keys for tags to remove from the resource.
Array Members: Minimum number of 0 items. Maximum number of 200 items.
Length Constraints: Minimum length of 1. Maximum length of 128.
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 200
Response ElementsIf the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 243).
InternalFailureException
AWS IoT SiteWise can't process your request right now. Try again later.
HTTP Status Code: 500InvalidRequestException
The request isn't valid. This can occur if your request contains malformed JSON or unsupportedcharacters. Check your request and try again.
HTTP Status Code: 400
API Version 2019-12-02142
AWS IoT SiteWise API ReferenceSee Also
ResourceNotFoundException
The requested resource can't be found.
HTTP Status Code: 404ThrottlingException
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoTSiteWise assets that can be created per second, the allowed number of messages per second, and soon.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
HTTP Status Code: 429
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2019-12-02143
AWS IoT SiteWise API ReferenceUpdateAccessPolicy
UpdateAccessPolicyUpdates an existing access policy that specifies an AWS SSO user or group's access to an AWS IoTSiteWise Monitor portal or project resource.
Request SyntaxPUT /access-policies/accessPolicyId HTTP/1.1Content-type: application/json
{ "accessPolicyIdentity": { "group": { "id": "string" }, "user": { "id": "string" } }, "accessPolicyPermission": "string", "accessPolicyResource": { "portal": { "id": "string" }, "project": { "id": "string" } }, "clientToken": "string"}
URI Request ParametersThe request requires the following URI parameters.
accessPolicyId (p. 144)
The ID of the access policy.
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Request BodyThe request accepts the following data in JSON format.
accessPolicyIdentity (p. 144)
The identity for this access policy. Choose either a user or a group but not both.
Type: Identity (p. 212) object
Required: YesaccessPolicyPermission (p. 144)
The permission level for this access policy. Note that a project ADMINISTRATOR is also known as aproject owner.
API Version 2019-12-02144
AWS IoT SiteWise API ReferenceResponse Syntax
Type: String
Valid Values: ADMINISTRATOR | VIEWER
Required: Yes
accessPolicyResource (p. 144)
The AWS IoT SiteWise Monitor resource for this access policy. Choose either portal or project butnot both.
Type: Resource (p. 234) object
Required: Yes
clientToken (p. 144)
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request.Don't reuse this client token if a new idempotent request is required.
Type: String
Length Constraints: Minimum length of 36. Maximum length of 64.
Pattern: \S{36,64}
Required: No
Response SyntaxHTTP/1.1 200
Response ElementsIf the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 243).
InternalFailureException
AWS IoT SiteWise can't process your request right now. Try again later.
HTTP Status Code: 500
InvalidRequestException
The request isn't valid. This can occur if your request contains malformed JSON or unsupportedcharacters. Check your request and try again.
HTTP Status Code: 400
ResourceNotFoundException
The requested resource can't be found.
HTTP Status Code: 404
API Version 2019-12-02145
AWS IoT SiteWise API ReferenceSee Also
ThrottlingException
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoTSiteWise assets that can be created per second, the allowed number of messages per second, and soon.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
HTTP Status Code: 429
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2019-12-02146
AWS IoT SiteWise API ReferenceUpdateAsset
UpdateAssetUpdates an asset's name. For more information, see Updating Assets and Models in the AWS IoT SiteWiseUser Guide.
Request SyntaxPUT /assets/assetId HTTP/1.1Content-type: application/json
{ "assetName": "string", "clientToken": "string"}
URI Request ParametersThe request requires the following URI parameters.
assetId (p. 147)
The ID of the asset to update.
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Request BodyThe request accepts the following data in JSON format.
assetName (p. 147)
A unique, friendly name for the asset.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: [^\u0000-\u001F\u007F]+
Required: Yes
clientToken (p. 147)
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request.Don't reuse this client token if a new idempotent request is required.
Type: String
Length Constraints: Minimum length of 36. Maximum length of 64.
Pattern: \S{36,64}
Required: No
API Version 2019-12-02147
AWS IoT SiteWise API ReferenceResponse Syntax
Response SyntaxHTTP/1.1 202Content-type: application/json
{ "assetStatus": { "error": { "code": "string", "message": "string" }, "state": "string" }}
Response ElementsIf the action is successful, the service sends back an HTTP 202 response.
The following data is returned in JSON format by the service.
assetStatus (p. 148)
The status of the asset, which contains a state (UPDATING after successfully calling this operation)and any error message.
Type: AssetStatus (p. 194) object
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 243).
ConflictingOperationException
Your request has conflicting operations. This can occur if you're trying to perform more than oneoperation on the same resource at the same time.
HTTP Status Code: 409InternalFailureException
AWS IoT SiteWise can't process your request right now. Try again later.
HTTP Status Code: 500InvalidRequestException
The request isn't valid. This can occur if your request contains malformed JSON or unsupportedcharacters. Check your request and try again.
HTTP Status Code: 400ResourceAlreadyExistsException
The resource already exists.
HTTP Status Code: 409ResourceNotFoundException
The requested resource can't be found.
API Version 2019-12-02148
AWS IoT SiteWise API ReferenceSee Also
HTTP Status Code: 404ThrottlingException
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoTSiteWise assets that can be created per second, the allowed number of messages per second, and soon.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
HTTP Status Code: 429
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2019-12-02149
AWS IoT SiteWise API ReferenceUpdateAssetModel
UpdateAssetModelUpdates an asset model and all of the assets that were created from the model. Each asset created fromthe model inherits the updated asset model's property and hierarchy definitions. For more information,see Updating Assets and Models in the AWS IoT SiteWise User Guide.
ImportantThis operation overwrites the existing model with the provided model. To avoid deleting yourasset model's properties or hierarchies, you must include their IDs and definitions in the updatedasset model payload. For more information, see DescribeAssetModel.If you remove a property from an asset model or update a property's formula expression, AWSIoT SiteWise deletes all previous data for that property. If you remove a hierarchy definitionfrom an asset model, AWS IoT SiteWise disassociates every asset associated with that hierarchy.You can't change the type or data type of an existing property.
Request Syntax
PUT /asset-models/assetModelId HTTP/1.1Content-type: application/json
{ "assetModelDescription": "string", "assetModelHierarchies": [ { "childAssetModelId": "string", "id": "string", "name": "string" } ], "assetModelName": "string", "assetModelProperties": [ { "dataType": "string", "id": "string", "name": "string", "type": { "attribute": { "defaultValue": "string" }, "measurement": { }, "metric": { "expression": "string", "variables": [ { "name": "string", "value": { "hierarchyId": "string", "propertyId": "string" } } ], "window": { "tumbling": { "interval": "string" } } }, "transform": { "expression": "string", "variables": [
API Version 2019-12-02150
AWS IoT SiteWise API ReferenceURI Request Parameters
{ "name": "string", "value": { "hierarchyId": "string", "propertyId": "string" } } ] } }, "unit": "string" } ], "clientToken": "string"}
URI Request ParametersThe request requires the following URI parameters.
assetModelId (p. 150)
The ID of the asset model to update.
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Request BodyThe request accepts the following data in JSON format.
assetModelDescription (p. 150)
A description for the asset model.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: [^\u0000-\u001F\u007F]+
Required: NoassetModelHierarchies (p. 150)
The updated hierarchy definitions of the asset model. Each hierarchy specifies an asset model whoseassets can be children of any other assets created from this asset model. For more information, seeAsset Hierarchies in the AWS IoT SiteWise User Guide.
You can specify up to 10 hierarchies per asset model. For more information, see Quotas in the AWSIoT SiteWise User Guide.
Type: Array of AssetModelHierarchy (p. 182) objects
Required: NoassetModelName (p. 150)
A unique, friendly name for the asset model.
API Version 2019-12-02151
AWS IoT SiteWise API ReferenceResponse Syntax
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: [^\u0000-\u001F\u007F]+
Required: YesassetModelProperties (p. 150)
The updated property definitions of the asset model. For more information, see Asset Properties inthe AWS IoT SiteWise User Guide.
You can specify up to 200 properties per asset model. For more information, see Quotas in the AWSIoT SiteWise User Guide.
Type: Array of AssetModelProperty (p. 184) objects
Required: NoclientToken (p. 150)
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request.Don't reuse this client token if a new idempotent request is required.
Type: String
Length Constraints: Minimum length of 36. Maximum length of 64.
Pattern: \S{36,64}
Required: No
Response SyntaxHTTP/1.1 202Content-type: application/json
{ "assetModelStatus": { "error": { "code": "string", "message": "string" }, "state": "string" }}
Response ElementsIf the action is successful, the service sends back an HTTP 202 response.
The following data is returned in JSON format by the service.
assetModelStatus (p. 152)
The status of the asset model, which contains a state (UPDATING after successfully calling thisoperation) and any error message.
Type: AssetModelStatus (p. 188) object
API Version 2019-12-02152
AWS IoT SiteWise API ReferenceErrors
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 243).
ConflictingOperationException
Your request has conflicting operations. This can occur if you're trying to perform more than oneoperation on the same resource at the same time.
HTTP Status Code: 409InternalFailureException
AWS IoT SiteWise can't process your request right now. Try again later.
HTTP Status Code: 500InvalidRequestException
The request isn't valid. This can occur if your request contains malformed JSON or unsupportedcharacters. Check your request and try again.
HTTP Status Code: 400LimitExceededException
You've reached the limit for a resource. For example, this can occur if you're trying to associate morethan the allowed number of child assets or attempting to create more than the allowed number ofproperties for an asset model.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
HTTP Status Code: 410ResourceAlreadyExistsException
The resource already exists.
HTTP Status Code: 409ResourceNotFoundException
The requested resource can't be found.
HTTP Status Code: 404ThrottlingException
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoTSiteWise assets that can be created per second, the allowed number of messages per second, and soon.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
HTTP Status Code: 429
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET
API Version 2019-12-02153
AWS IoT SiteWise API ReferenceSee Also
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2019-12-02154
AWS IoT SiteWise API ReferenceUpdateAssetProperty
UpdateAssetPropertyUpdates an asset property's alias and notification state.
ImportantThis operation overwrites the property's existing alias and notification state. To keep yourexisting property's alias or notification state, you must include the existing values in theUpdateAssetProperty request. For more information, see DescribeAssetProperty.
Request SyntaxPUT /assets/assetId/properties/propertyId HTTP/1.1Content-type: application/json
{ "clientToken": "string", "propertyAlias": "string", "propertyNotificationState": "string"}
URI Request ParametersThe request requires the following URI parameters.
assetId (p. 155)
The ID of the asset to be updated.
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$propertyId (p. 155)
The ID of the asset property to be updated.
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Request BodyThe request accepts the following data in JSON format.
clientToken (p. 155)
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request.Don't reuse this client token if a new idempotent request is required.
Type: String
Length Constraints: Minimum length of 36. Maximum length of 64.
Pattern: \S{36,64}
Required: No
API Version 2019-12-02155
AWS IoT SiteWise API ReferenceResponse Syntax
propertyAlias (p. 155)
The property alias that identifies the property, such as an OPC-UA server data stream path (forexample, /company/windfarm/3/turbine/7/temperature). For more information, seeMapping Industrial Data Streams to Asset Properties in the AWS IoT SiteWise User Guide.
If you omit this parameter, the alias is removed from the property.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: [^\u0000-\u001F\u007F]+
Required: NopropertyNotificationState (p. 155)
The MQTT notification state (enabled or disabled) for this asset property. When the notificationstate is enabled, AWS IoT SiteWise publishes property value updates to a unique MQTT topic. Formore information, see Interacting with Other Services in the AWS IoT SiteWise User Guide.
If you omit this parameter, the notification state is set to DISABLED.
Type: String
Valid Values: ENABLED | DISABLED
Required: No
Response SyntaxHTTP/1.1 200
Response ElementsIf the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 243).
ConflictingOperationException
Your request has conflicting operations. This can occur if you're trying to perform more than oneoperation on the same resource at the same time.
HTTP Status Code: 409InternalFailureException
AWS IoT SiteWise can't process your request right now. Try again later.
HTTP Status Code: 500InvalidRequestException
The request isn't valid. This can occur if your request contains malformed JSON or unsupportedcharacters. Check your request and try again.
API Version 2019-12-02156
AWS IoT SiteWise API ReferenceSee Also
HTTP Status Code: 400ResourceNotFoundException
The requested resource can't be found.
HTTP Status Code: 404ThrottlingException
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoTSiteWise assets that can be created per second, the allowed number of messages per second, and soon.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
HTTP Status Code: 429
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2019-12-02157
AWS IoT SiteWise API ReferenceUpdateDashboard
UpdateDashboardUpdates an AWS IoT SiteWise Monitor dashboard.
Request SyntaxPUT /dashboards/dashboardId HTTP/1.1Content-type: application/json
{ "clientToken": "string", "dashboardDefinition": "string", "dashboardDescription": "string", "dashboardName": "string"}
URI Request ParametersThe request requires the following URI parameters.
dashboardId (p. 158)
The ID of the dashboard to update.
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Request BodyThe request accepts the following data in JSON format.
clientToken (p. 158)
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request.Don't reuse this client token if a new idempotent request is required.
Type: String
Length Constraints: Minimum length of 36. Maximum length of 64.
Pattern: \S{36,64}
Required: NodashboardDefinition (p. 158)
The new dashboard definition, as specified in a JSON literal. For detailed information, see CreatingDashboards (CLI) in the AWS IoT SiteWise User Guide.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 204800.
Pattern: .+
Required: Yes
API Version 2019-12-02158
AWS IoT SiteWise API ReferenceResponse Syntax
dashboardDescription (p. 158)
A new description for the dashboard.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: [^\u0000-\u001F\u007F]+
Required: NodashboardName (p. 158)
A new friendly name for the dashboard.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: [^\u0000-\u001F\u007F]+
Required: Yes
Response SyntaxHTTP/1.1 200
Response ElementsIf the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 243).
InternalFailureException
AWS IoT SiteWise can't process your request right now. Try again later.
HTTP Status Code: 500InvalidRequestException
The request isn't valid. This can occur if your request contains malformed JSON or unsupportedcharacters. Check your request and try again.
HTTP Status Code: 400ResourceNotFoundException
The requested resource can't be found.
HTTP Status Code: 404ThrottlingException
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoTSiteWise assets that can be created per second, the allowed number of messages per second, and soon.
API Version 2019-12-02159
AWS IoT SiteWise API ReferenceSee Also
For more information, see Quotas in the AWS IoT SiteWise User Guide.
HTTP Status Code: 429
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2019-12-02160
AWS IoT SiteWise API ReferenceUpdateGateway
UpdateGatewayUpdates a gateway's name.
Request SyntaxPUT /20200301/gateways/gatewayId HTTP/1.1Content-type: application/json
{ "gatewayName": "string"}
URI Request ParametersThe request requires the following URI parameters.
gatewayId (p. 161)
The ID of the gateway to update.
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Request BodyThe request accepts the following data in JSON format.
gatewayName (p. 161)
A unique, friendly name for the gateway.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: [^\u0000-\u001F\u007F]+
Required: Yes
Response SyntaxHTTP/1.1 200
Response ElementsIf the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 243).
API Version 2019-12-02161
AWS IoT SiteWise API ReferenceSee Also
ConflictingOperationException
Your request has conflicting operations. This can occur if you're trying to perform more than oneoperation on the same resource at the same time.
HTTP Status Code: 409InternalFailureException
AWS IoT SiteWise can't process your request right now. Try again later.
HTTP Status Code: 500InvalidRequestException
The request isn't valid. This can occur if your request contains malformed JSON or unsupportedcharacters. Check your request and try again.
HTTP Status Code: 400ResourceNotFoundException
The requested resource can't be found.
HTTP Status Code: 404ThrottlingException
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoTSiteWise assets that can be created per second, the allowed number of messages per second, and soon.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
HTTP Status Code: 429
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2019-12-02162
AWS IoT SiteWise API ReferenceUpdateGatewayCapabilityConfiguration
UpdateGatewayCapabilityConfigurationUpdates a gateway capability configuration or defines a new capability configuration. Each gatewaycapability defines data sources for a gateway. A capability configuration can contain multiple data sourceconfigurations. If you define OPC-UA sources for a gateway in the AWS IoT SiteWise console, all of yourOPC-UA sources are stored in one capability configuration. To list all capability configurations for agateway, use DescribeGateway.
Request SyntaxPOST /20200301/gateways/gatewayId/capability HTTP/1.1Content-type: application/json
{ "capabilityConfiguration": "string", "capabilityNamespace": "string"}
URI Request ParametersThe request requires the following URI parameters.
gatewayId (p. 163)
The ID of the gateway to be updated.
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Request BodyThe request accepts the following data in JSON format.
capabilityConfiguration (p. 163)
The JSON document that defines the configuration for the gateway capability. For more information,see Configuring data sources (CLI) in the AWS IoT SiteWise User Guide.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 204800.
Required: YescapabilityNamespace (p. 163)
The namespace of the gateway capability configuration to be updated. For example, if you configureOPC-UA sources from the AWS IoT SiteWise console, your OPC-UA capability configuration has thenamespace iotsitewise:opcuacollector:version, where version is a number such as 1.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 512.
Pattern: ^[a-zA-Z]+:[a-zA-Z]+:[0-9]+$
API Version 2019-12-02163
AWS IoT SiteWise API ReferenceResponse Syntax
Required: Yes
Response SyntaxHTTP/1.1 201Content-type: application/json
{ "capabilityNamespace": "string", "capabilitySyncStatus": "string"}
Response ElementsIf the action is successful, the service sends back an HTTP 201 response.
The following data is returned in JSON format by the service.
capabilityNamespace (p. 164)
The namespace of the gateway capability.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 512.
Pattern: ^[a-zA-Z]+:[a-zA-Z]+:[0-9]+$capabilitySyncStatus (p. 164)
The synchronization status of the capability configuration. The sync status can be one of thefollowing:• IN_SYNC – The gateway is running the capability configuration.• OUT_OF_SYNC – The gateway hasn't received the capability configuration.• SYNC_FAILED – The gateway rejected the capability configuration.
After you update a capability configuration, its sync status is OUT_OF_SYNC until the gatewayreceives and applies or rejects the updated configuration.
Type: String
Valid Values: IN_SYNC | OUT_OF_SYNC | SYNC_FAILED
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 243).
ConflictingOperationException
Your request has conflicting operations. This can occur if you're trying to perform more than oneoperation on the same resource at the same time.
HTTP Status Code: 409InternalFailureException
AWS IoT SiteWise can't process your request right now. Try again later.
API Version 2019-12-02164
AWS IoT SiteWise API ReferenceSee Also
HTTP Status Code: 500InvalidRequestException
The request isn't valid. This can occur if your request contains malformed JSON or unsupportedcharacters. Check your request and try again.
HTTP Status Code: 400LimitExceededException
You've reached the limit for a resource. For example, this can occur if you're trying to associate morethan the allowed number of child assets or attempting to create more than the allowed number ofproperties for an asset model.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
HTTP Status Code: 410ResourceNotFoundException
The requested resource can't be found.
HTTP Status Code: 404ThrottlingException
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoTSiteWise assets that can be created per second, the allowed number of messages per second, and soon.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
HTTP Status Code: 429
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2019-12-02165
AWS IoT SiteWise API ReferenceUpdatePortal
UpdatePortalUpdates an AWS IoT SiteWise Monitor portal.
Request SyntaxPUT /portals/portalId HTTP/1.1Content-type: application/json
{ "clientToken": "string", "portalContactEmail": "string", "portalDescription": "string", "portalLogoImage": { "file": { "data": blob, "type": "string" }, "id": "string" }, "portalName": "string", "roleArn": "string"}
URI Request ParametersThe request requires the following URI parameters.
portalId (p. 166)
The ID of the portal to update.
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Request BodyThe request accepts the following data in JSON format.
clientToken (p. 166)
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request.Don't reuse this client token if a new idempotent request is required.
Type: String
Length Constraints: Minimum length of 36. Maximum length of 64.
Pattern: \S{36,64}
Required: NoportalContactEmail (p. 166)
The AWS administrator's contact email address.
Type: String
API Version 2019-12-02166
AWS IoT SiteWise API ReferenceResponse Syntax
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: [^@]+@[^@]+
Required: YesportalDescription (p. 166)
A new description for the portal.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: [^\u0000-\u001F\u007F]+
Required: NoportalLogoImage (p. 166)
Contains an image that is one of the following:• An image file. Choose this option to upload a new image.• The ID of an existing image. Choose this option to keep an existing image.
Type: Image (p. 213) object
Required: NoportalName (p. 166)
A new friendly name for the portal.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: [^\u0000-\u001F\u007F]+
Required: YesroleArn (p. 166)
The ARN of a service role that allows the portal's users to access your AWS IoT SiteWise resources onyour behalf. For more information, see Using service roles for AWS IoT SiteWise Monitor in the AWSIoT SiteWise User Guide.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
Pattern: .*
Required: Yes
Response SyntaxHTTP/1.1 202Content-type: application/json
{ "portalStatus": {
API Version 2019-12-02167
AWS IoT SiteWise API ReferenceResponse Elements
"error": { "code": "string", "message": "string" }, "state": "string" }}
Response ElementsIf the action is successful, the service sends back an HTTP 202 response.
The following data is returned in JSON format by the service.
portalStatus (p. 167)
The status of the portal, which contains a state (UPDATING after successfully calling this operation)and any error message.
Type: PortalStatus (p. 222) object
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 243).
ConflictingOperationException
Your request has conflicting operations. This can occur if you're trying to perform more than oneoperation on the same resource at the same time.
HTTP Status Code: 409
InternalFailureException
AWS IoT SiteWise can't process your request right now. Try again later.
HTTP Status Code: 500
InvalidRequestException
The request isn't valid. This can occur if your request contains malformed JSON or unsupportedcharacters. Check your request and try again.
HTTP Status Code: 400
ResourceNotFoundException
The requested resource can't be found.
HTTP Status Code: 404
ThrottlingException
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoTSiteWise assets that can be created per second, the allowed number of messages per second, and soon.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
HTTP Status Code: 429
API Version 2019-12-02168
AWS IoT SiteWise API ReferenceSee Also
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2019-12-02169
AWS IoT SiteWise API ReferenceUpdateProject
UpdateProjectUpdates an AWS IoT SiteWise Monitor project.
Request SyntaxPUT /projects/projectId HTTP/1.1Content-type: application/json
{ "clientToken": "string", "projectDescription": "string", "projectName": "string"}
URI Request ParametersThe request requires the following URI parameters.
projectId (p. 170)
The ID of the project to update.
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Request BodyThe request accepts the following data in JSON format.
clientToken (p. 170)
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request.Don't reuse this client token if a new idempotent request is required.
Type: String
Length Constraints: Minimum length of 36. Maximum length of 64.
Pattern: \S{36,64}
Required: NoprojectDescription (p. 170)
A new description for the project.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: [^\u0000-\u001F\u007F]+
Required: NoprojectName (p. 170)
A new friendly name for the project.
API Version 2019-12-02170
AWS IoT SiteWise API ReferenceResponse Syntax
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: [^\u0000-\u001F\u007F]+
Required: Yes
Response SyntaxHTTP/1.1 200
Response ElementsIf the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 243).
InternalFailureException
AWS IoT SiteWise can't process your request right now. Try again later.
HTTP Status Code: 500InvalidRequestException
The request isn't valid. This can occur if your request contains malformed JSON or unsupportedcharacters. Check your request and try again.
HTTP Status Code: 400ResourceNotFoundException
The requested resource can't be found.
HTTP Status Code: 404ThrottlingException
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoTSiteWise assets that can be created per second, the allowed number of messages per second, and soon.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
HTTP Status Code: 429
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++
API Version 2019-12-02171
AWS IoT SiteWise API ReferenceSee Also
• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2019-12-02172
AWS IoT SiteWise API Reference
Data TypesThe AWS IoT SiteWise API contains several data types that various actions use. This section describeseach data type in detail.
NoteThe order of each element in a data type structure is not guaranteed. Applications should notassume a particular order.
The following data types are supported:
• AccessPolicySummary (p. 175)• AggregatedValue (p. 177)• Aggregates (p. 178)• AssetErrorDetails (p. 180)• AssetHierarchy (p. 181)• AssetModelHierarchy (p. 182)• AssetModelHierarchyDefinition (p. 183)• AssetModelProperty (p. 184)• AssetModelPropertyDefinition (p. 186)• AssetModelStatus (p. 188)• AssetModelSummary (p. 189)• AssetProperty (p. 191)• AssetPropertyValue (p. 193)• AssetStatus (p. 194)• AssetSummary (p. 195)• AssociatedAssetsSummary (p. 197)• Attribute (p. 199)• BatchPutAssetPropertyError (p. 200)• BatchPutAssetPropertyErrorEntry (p. 201)• DashboardSummary (p. 202)• ErrorDetails (p. 204)• ExpressionVariable (p. 205)• GatewayCapabilitySummary (p. 206)• GatewayPlatform (p. 207)• GatewaySummary (p. 208)• Greengrass (p. 210)• GroupIdentity (p. 211)• Identity (p. 212)• Image (p. 213)• ImageFile (p. 214)• ImageLocation (p. 215)• LoggingOptions (p. 216)• Measurement (p. 217)• Metric (p. 218)• MetricWindow (p. 219)
API Version 2019-12-02173
AWS IoT SiteWise API Reference
• MonitorErrorDetails (p. 220)• PortalResource (p. 221)• PortalStatus (p. 222)• PortalSummary (p. 223)• ProjectResource (p. 225)• ProjectSummary (p. 226)• Property (p. 228)• PropertyNotification (p. 230)• PropertyType (p. 231)• PutAssetPropertyValueEntry (p. 232)• Resource (p. 234)• TimeInNanos (p. 235)• Transform (p. 236)• TumblingWindow (p. 237)• UserIdentity (p. 238)• VariableValue (p. 239)• Variant (p. 240)
API Version 2019-12-02174
AWS IoT SiteWise API ReferenceAccessPolicySummary
AccessPolicySummaryContains an access policy that defines an AWS SSO identity's access to an AWS IoT SiteWise Monitorresource.
ContentscreationDate
The date the access policy was created, in Unix epoch time.
Type: Timestamp
Required: No
id
The ID of the access policy.
Type: String
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Required: Yes
identity
The AWS SSO identity (a user or group).
Type: Identity (p. 212) object
Required: Yes
lastUpdateDate
The date the access policy was last updated, in Unix epoch time.
Type: Timestamp
Required: No
permission
The permissions for the access policy. Note that a project ADMINISTRATOR is also known as a projectowner.
Type: String
Valid Values: ADMINISTRATOR | VIEWER
Required: Yes
resource
The AWS IoT SiteWise Monitor resource (a portal or project).
Type: Resource (p. 234) object
Required: Yes
API Version 2019-12-02175
AWS IoT SiteWise API ReferenceSee Also
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3
API Version 2019-12-02176
AWS IoT SiteWise API ReferenceAggregatedValue
AggregatedValueContains aggregated asset property values (for example, average, minimum, and maximum).
Contentsquality
The quality of the aggregated data.
Type: String
Valid Values: GOOD | BAD | UNCERTAIN
Required: Notimestamp
The date the aggregating computations occurred, in Unix epoch time.
Type: Timestamp
Required: Yesvalue
The value of the aggregates.
Type: Aggregates (p. 178) object
Required: Yes
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3
API Version 2019-12-02177
AWS IoT SiteWise API ReferenceAggregates
AggregatesContains the (pre-calculated) aggregate values for an asset property.
Contentsaverage
The average (mean) value of the time series over a time interval window.
Type: Double
Required: Nocount
The count of data points in the time series over a time interval window.
Type: Double
Required: Nomaximum
The maximum value of the time series over a time interval window.
Type: Double
Required: Nominimum
The minimum value of the time series over a time interval window.
Type: Double
Required: NostandardDeviation
The standard deviation of the time series over a time interval window.
Type: Double
Required: Nosum
The sum of the time series over a time interval window.
Type: Double
Required: No
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java
API Version 2019-12-02178
AWS IoT SiteWise API ReferenceSee Also
• AWS SDK for Ruby V3
API Version 2019-12-02179
AWS IoT SiteWise API ReferenceAssetErrorDetails
AssetErrorDetailsContains error details for the requested associate project asset action.
ContentsassetId
The ID of the asset.
Type: String
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Required: Yescode
The error code.
Type: String
Valid Values: INTERNAL_FAILURE
Required: Yesmessage
The error message.
Type: String
Required: Yes
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3
API Version 2019-12-02180
AWS IoT SiteWise API ReferenceAssetHierarchy
AssetHierarchyDescribes an asset hierarchy that contains a hierarchy's name and ID.
Contentsid
The ID of the hierarchy. This ID is a hierarchyId.
Type: String
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Required: Noname
The hierarchy name provided in the CreateAssetModel or UpdateAssetModel API.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: [^\u0000-\u001F\u007F]+
Required: Yes
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3
API Version 2019-12-02181
AWS IoT SiteWise API ReferenceAssetModelHierarchy
AssetModelHierarchyDescribes an asset hierarchy that contains a hierarchy's name, ID, and child asset model ID that specifiesthe type of asset that can be in this hierarchy.
ContentschildAssetModelId
The ID of the asset model. All assets in this hierarchy must be instances of the childAssetModelIdasset model.
Type: String
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Required: Yesid
The ID of the asset model hierarchy. This ID is a hierarchyId.
Type: String
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Required: Noname
The name of the asset model hierarchy that you specify by using the CreateAssetModel orUpdateAssetModel API.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: [^\u0000-\u001F\u007F]+
Required: Yes
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3
API Version 2019-12-02182
AWS IoT SiteWise API ReferenceAssetModelHierarchyDefinition
AssetModelHierarchyDefinitionContains an asset model hierarchy used in asset model creation. An asset model hierarchy determinesthe kind (or type) of asset that can belong to a hierarchy.
ContentschildAssetModelId
The ID of an asset model for this hierarchy.
Type: String
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Required: Yesname
The name of the asset model hierarchy definition (as specified in CreateAssetModel orUpdateAssetModel).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: [^\u0000-\u001F\u007F]+
Required: Yes
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3
API Version 2019-12-02183
AWS IoT SiteWise API ReferenceAssetModelProperty
AssetModelPropertyContains information about an asset model property.
ContentsdataType
The data type of the asset model property.
Type: String
Valid Values: STRING | INTEGER | DOUBLE | BOOLEAN
Required: Yesid
The ID of the asset model property.
Type: String
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Required: Noname
The name of the asset model property.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: [^\u0000-\u001F\u007F]+
Required: Yestype
The property type (see PropertyType).
Type: PropertyType (p. 231) object
Required: Yesunit
The unit of the asset model property, such as Newtons or RPM.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: [^\u0000-\u001F\u007F]+
Required: No
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
API Version 2019-12-02184
AWS IoT SiteWise API ReferenceSee Also
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3
API Version 2019-12-02185
AWS IoT SiteWise API ReferenceAssetModelPropertyDefinition
AssetModelPropertyDefinitionContains an asset model property definition. This property definition is applied to all assets created fromthe asset model.
ContentsdataType
The data type of the property definition.
Type: String
Valid Values: STRING | INTEGER | DOUBLE | BOOLEAN
Required: Yesname
The name of the property definition.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: [^\u0000-\u001F\u007F]+
Required: Yestype
The property definition type (see PropertyType). You can only specify one type in a propertydefinition.
Type: PropertyType (p. 231) object
Required: Yesunit
The unit of the property definition, such as Newtons or RPM.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: [^\u0000-\u001F\u007F]+
Required: No
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3
API Version 2019-12-02186
AWS IoT SiteWise API ReferenceSee Also
API Version 2019-12-02187
AWS IoT SiteWise API ReferenceAssetModelStatus
AssetModelStatusContains current status information for an asset model. For more information, see Asset and ModelStates in the AWS IoT SiteWise User Guide.
Contentserror
Contains associated error information, if any.
Type: ErrorDetails (p. 204) object
Required: Nostate
The current state of the asset model.
Type: String
Valid Values: CREATING | ACTIVE | UPDATING | PROPAGATING | DELETING | FAILED
Required: Yes
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3
API Version 2019-12-02188
AWS IoT SiteWise API ReferenceAssetModelSummary
AssetModelSummaryContains a summary of an asset model.
Contentsarn
The ARN of the asset model, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
Pattern: .*
Required: YescreationDate
The date the asset model was created, in Unix epoch time.
Type: Timestamp
Required: Yesdescription
The asset model description.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: [^\u0000-\u001F\u007F]+
Required: Yesid
The ID of the asset model (used with AWS IoT SiteWise APIs).
Type: String
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Required: YeslastUpdateDate
The date the asset model was last updated, in Unix epoch time.
Type: Timestamp
Required: Yesname
The name of the asset model.
API Version 2019-12-02189
AWS IoT SiteWise API ReferenceSee Also
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: [^\u0000-\u001F\u007F]+
Required: Yesstatus
The current status of the asset model.
Type: AssetModelStatus (p. 188) object
Required: Yes
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3
API Version 2019-12-02190
AWS IoT SiteWise API ReferenceAssetProperty
AssetPropertyContains asset property information.
Contentsalias
The property alias that identifies the property, such as an OPC-UA server data stream path (forexample, /company/windfarm/3/turbine/7/temperature). For more information, seeMapping Industrial Data Streams to Asset Properties in the AWS IoT SiteWise User Guide.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: [^\u0000-\u001F\u007F]+
Required: NodataType
The data type of the asset property.
Type: String
Valid Values: STRING | INTEGER | DOUBLE | BOOLEAN
Required: Yesid
The ID of the asset property.
Type: String
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Required: Yesname
The name of the property.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: [^\u0000-\u001F\u007F]+
Required: Yesnotification
The asset property's notification topic and state. For more information, see UpdateAssetProperty
Type: PropertyNotification (p. 230) object
Required: No
API Version 2019-12-02191
AWS IoT SiteWise API ReferenceSee Also
unit
The unit (such as Newtons or RPM) of the asset property.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: [^\u0000-\u001F\u007F]+
Required: No
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3
API Version 2019-12-02192
AWS IoT SiteWise API ReferenceAssetPropertyValue
AssetPropertyValueContains asset property value information.
Contentsquality
The quality of the asset property value.
Type: String
Valid Values: GOOD | BAD | UNCERTAIN
Required: Notimestamp
The timestamp of the asset property value.
Type: TimeInNanos (p. 235) object
Required: Yesvalue
The value of the asset property (see Variant).
Type: Variant (p. 240) object
Required: Yes
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3
API Version 2019-12-02193
AWS IoT SiteWise API ReferenceAssetStatus
AssetStatusContains information about the current status of an asset. For more information, see Asset and ModelStates in the AWS IoT SiteWise User Guide.
Contentserror
Contains associated error information, if any.
Type: ErrorDetails (p. 204) object
Required: Nostate
The current status of the asset.
Type: String
Valid Values: CREATING | ACTIVE | UPDATING | DELETING | FAILED
Required: Yes
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3
API Version 2019-12-02194
AWS IoT SiteWise API ReferenceAssetSummary
AssetSummaryContains a summary of an asset.
Contentsarn
The ARN of the asset, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
Pattern: .*
Required: YesassetModelId
The ID of the asset model used to create this asset.
Type: String
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Required: YescreationDate
The date the asset was created, in Unix epoch time.
Type: Timestamp
Required: Yeshierarchies
A list of asset hierarchies that each contain a hierarchyId. A hierarchy specifies allowed parent/child asset relationships.
Type: Array of AssetHierarchy (p. 181) objects
Required: Yesid
The ID of the asset.
Type: String
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Required: YeslastUpdateDate
The date the asset was last updated, in Unix epoch time.
API Version 2019-12-02195
AWS IoT SiteWise API ReferenceSee Also
Type: Timestamp
Required: Yesname
The name of the asset.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: [^\u0000-\u001F\u007F]+
Required: Yesstatus
The current status of the asset.
Type: AssetStatus (p. 194) object
Required: Yes
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3
API Version 2019-12-02196
AWS IoT SiteWise API ReferenceAssociatedAssetsSummary
AssociatedAssetsSummaryContains a summary of an associated asset.
Contentsarn
The ARN of the asset, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
Pattern: .*
Required: YesassetModelId
The ID of the asset model used to create the asset.
Type: String
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Required: YescreationDate
The date the asset was created, in Unix epoch time.
Type: Timestamp
Required: Yeshierarchies
A list of asset hierarchies that each contain a hierarchyId. A hierarchy specifies allowed parent/child asset relationships.
Type: Array of AssetHierarchy (p. 181) objects
Required: Yesid
The ID of the asset.
Type: String
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Required: YeslastUpdateDate
The date the asset was last updated, in Unix epoch time.
API Version 2019-12-02197
AWS IoT SiteWise API ReferenceSee Also
Type: Timestamp
Required: Yesname
The name of the asset.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: [^\u0000-\u001F\u007F]+
Required: Yesstatus
The current status of the asset.
Type: AssetStatus (p. 194) object
Required: Yes
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3
API Version 2019-12-02198
AWS IoT SiteWise API ReferenceAttribute
AttributeContains an asset attribute property. For more information, see Attributes in the AWS IoT SiteWise UserGuide.
ContentsdefaultValue
The default value of the asset model property attribute. All assets that you create from the assetmodel contain this attribute value. You can update an attribute's value after you create an asset. Formore information, see Updating Attribute Values in the AWS IoT SiteWise User Guide.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern: [^\u0000-\u001F\u007F]+
Required: No
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3
API Version 2019-12-02199
AWS IoT SiteWise API ReferenceBatchPutAssetPropertyError
BatchPutAssetPropertyErrorContains error information from updating a batch of asset property values.
ContentserrorCode
The error code.
Type: String
Valid Values: ResourceNotFoundException | InvalidRequestException |InternalFailureException | ServiceUnavailableException | ThrottlingException| LimitExceededException | ConflictingOperationException |TimestampOutOfRangeException | AccessDeniedException
Required: YeserrorMessage
The associated error message.
Type: String
Required: Yestimestamps
A list of timestamps for each error, if any.
Type: Array of TimeInNanos (p. 235) objects
Required: Yes
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3
API Version 2019-12-02200
AWS IoT SiteWise API ReferenceBatchPutAssetPropertyErrorEntry
BatchPutAssetPropertyErrorEntryContains error information for asset property value entries that are associated with theBatchPutAssetPropertyValue API.
ContentsentryId
The ID of the failed entry.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: ^[a-zA-Z0-9_-]+$
Required: Yeserrors
The list of update property value errors.
Type: Array of BatchPutAssetPropertyError (p. 200) objects
Required: Yes
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3
API Version 2019-12-02201
AWS IoT SiteWise API ReferenceDashboardSummary
DashboardSummaryContains a dashboard summary.
ContentscreationDate
The date the dashboard was created, in Unix epoch time.
Type: Timestamp
Required: Nodescription
The dashboard's description.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: [^\u0000-\u001F\u007F]+
Required: Noid
The ID of the dashboard.
Type: String
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Required: YeslastUpdateDate
The date the dashboard was last updated, in Unix epoch time.
Type: Timestamp
Required: Noname
The name of the dashboard
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: [^\u0000-\u001F\u007F]+
Required: Yes
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
API Version 2019-12-02202
AWS IoT SiteWise API ReferenceSee Also
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3
API Version 2019-12-02203
AWS IoT SiteWise API ReferenceErrorDetails
ErrorDetailsContains the details of an AWS IoT SiteWise error.
Contentscode
The error code.
Type: String
Valid Values: VALIDATION_ERROR | INTERNAL_FAILURE
Required: Yesmessage
The error message.
Type: String
Required: Yes
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3
API Version 2019-12-02204
AWS IoT SiteWise API ReferenceExpressionVariable
ExpressionVariableContains expression variable information.
Contentsname
The friendly name of the variable to be used in the expression.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: ^[a-z][a-z0-9_]*$
Required: Yesvalue
The variable that identifies an asset property from which to use values.
Type: VariableValue (p. 239) object
Required: Yes
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3
API Version 2019-12-02205
AWS IoT SiteWise API ReferenceGatewayCapabilitySummary
GatewayCapabilitySummaryContains a summary of a gateway capability configuration.
ContentscapabilityNamespace
The namespace of the capability configuration. For example, if you configure OPC-UA sourcesfrom the AWS IoT SiteWise console, your OPC-UA capability configuration has the namespaceiotsitewise:opcuacollector:version, where version is a number such as 1.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 512.
Pattern: ^[a-zA-Z]+:[a-zA-Z]+:[0-9]+$
Required: YescapabilitySyncStatus
The synchronization status of the capability configuration. The sync status can be one of thefollowing:• IN_SYNC – The gateway is running the capability configuration.• OUT_OF_SYNC – The gateway hasn't received the capability configuration.• SYNC_FAILED – The gateway rejected the capability configuration.
Type: String
Valid Values: IN_SYNC | OUT_OF_SYNC | SYNC_FAILED
Required: Yes
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3
API Version 2019-12-02206
AWS IoT SiteWise API ReferenceGatewayPlatform
GatewayPlatformContains a gateway's platform information.
Contentsgreengrass
A gateway that runs on AWS IoT Greengrass.
Type: Greengrass (p. 210) object
Required: Yes
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3
API Version 2019-12-02207
AWS IoT SiteWise API ReferenceGatewaySummary
GatewaySummaryContains a summary of a gateway.
ContentscreationDate
The date the gateway was created, in Unix epoch time.
Type: Timestamp
Required: YesgatewayCapabilitySummaries
A list of gateway capability summaries that each contain a namespace and status. Each gatewaycapability defines data sources for the gateway. To retrieve a capability configuration's definition,use DescribeGatewayCapabilityConfiguration.
Type: Array of GatewayCapabilitySummary (p. 206) objects
Required: NogatewayId
The ID of the gateway device.
Type: String
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Required: YesgatewayName
The name of the asset.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: [^\u0000-\u001F\u007F]+
Required: YeslastUpdateDate
The date the gateway was last updated, in Unix epoch time.
Type: Timestamp
Required: Yes
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
API Version 2019-12-02208
AWS IoT SiteWise API ReferenceSee Also
• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3
API Version 2019-12-02209
AWS IoT SiteWise API ReferenceGreengrass
GreengrassContains details for a gateway that runs on AWS IoT Greengrass. To create a gateway that runs on AWSIoT Greengrass, you must add the IoT SiteWise connector to a Greengrass group and deploy it. YourGreengrass group must also have permissions to upload data to AWS IoT SiteWise. For more information,see Ingesting data using a gateway in the AWS IoT SiteWise User Guide.
ContentsgroupArn
The ARN of the Greengrass group. For more information about how to find a group's ARN, seeListGroups and GetGroup in the AWS IoT Greengrass API Reference.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
Pattern: .*
Required: Yes
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3
API Version 2019-12-02210
AWS IoT SiteWise API ReferenceGroupIdentity
GroupIdentityContains information for a group identity in an access policy.
Contentsid
The AWS SSO ID of the group.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: \S+
Required: Yes
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3
API Version 2019-12-02211
AWS IoT SiteWise API ReferenceIdentity
IdentityContains an AWS SSO identity ID for a user or group.
NoteCurrently, you can't use AWS APIs to retrieve AWS SSO identity IDs. You can find the AWS SSOidentity IDs in the URL of user and group pages in the AWS SSO console.
Contentsgroup
A group identity.
Type: GroupIdentity (p. 211) object
Required: Nouser
A user identity.
Type: UserIdentity (p. 238) object
Required: No
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3
API Version 2019-12-02212
AWS IoT SiteWise API ReferenceImage
ImageContains an image that is one of the following:
• An image file. Choose this option to upload a new image.• The ID of an existing image. Choose this option to keep an existing image.
Contentsfile
Contains an image file.
Type: ImageFile (p. 214) object
Required: Noid
The ID of an existing image. Specify this parameter to keep an existing image.
Type: String
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Required: No
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3
API Version 2019-12-02213
AWS IoT SiteWise API ReferenceImageFile
ImageFileContains an image file.
Contentsdata
The image file contents, represented as a base64-encoded string. The file size must be less than 1MB.
Type: Base64-encoded binary data object
Length Constraints: Minimum length of 1. Maximum length of 1500000.
Required: Yestype
The file type of the image.
Type: String
Valid Values: PNG
Required: Yes
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3
API Version 2019-12-02214
AWS IoT SiteWise API ReferenceImageLocation
ImageLocationContains an image that is uploaded to AWS IoT SiteWise and available at a URL.
Contentsid
The ID of the image.
Type: String
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Required: Yesurl
The URL where the image is available. The URL is valid for 15 minutes so that you can view anddownload the image
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: ^(http|https)\://\S+
Required: Yes
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3
API Version 2019-12-02215
AWS IoT SiteWise API ReferenceLoggingOptions
LoggingOptionsContains logging options.
Contentslevel
The AWS IoT SiteWise logging verbosity level.
Type: String
Valid Values: ERROR | INFO | OFF
Required: Yes
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3
API Version 2019-12-02216
AWS IoT SiteWise API ReferenceMeasurement
MeasurementContains an asset measurement property. This structure is empty. For more information, seeMeasurements in the AWS IoT SiteWise User Guide.
ContentsThe members of this structure are context-dependent.
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3
API Version 2019-12-02217
AWS IoT SiteWise API ReferenceMetric
MetricContains an asset metric property. With metrics, you can calculate aggregate functions, such as anaverage, maximum, or minimum, as specified through an expression. A metric maps several values to asingle value (such as a sum).
The maximum number of dependent/cascading variables used in any one metric calculation is 10.Therefore, a root metric can have up to 10 cascading metrics in its computational dependency tree.Additionally, a metric can only have a data type of DOUBLE and consume properties with data types ofINTEGER or DOUBLE.
For more information, see Metrics in the AWS IoT SiteWise User Guide.
Contentsexpression
The mathematical expression that defines the metric aggregation function. You can specify up to 10variables per expression. You can specify up to 10 functions per expression.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern: ^[a-z0-9._+\-*%/^, ()]+$
Required: Yesvariables
The list of variables used in the expression.
Type: Array of ExpressionVariable (p. 205) objects
Required: Yeswindow
The window (time interval) over which AWS IoT SiteWise computes the metric's aggregationexpression. AWS IoT SiteWise computes one data point per window.
Type: MetricWindow (p. 219) object
Required: Yes
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3
API Version 2019-12-02218
AWS IoT SiteWise API ReferenceMetricWindow
MetricWindowContains a time interval window used for data aggregate computations (for example, average, sum,count, and so on).
Contentstumbling
The tumbling time interval window.
Type: TumblingWindow (p. 237) object
Required: No
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3
API Version 2019-12-02219
AWS IoT SiteWise API ReferenceMonitorErrorDetails
MonitorErrorDetailsContains AWS IoT SiteWise Monitor error details.
Contentscode
The error code.
Type: String
Valid Values: INTERNAL_FAILURE
Required: Nomessage
The error message.
Type: String
Required: No
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3
API Version 2019-12-02220
AWS IoT SiteWise API ReferencePortalResource
PortalResourceIdentifies an AWS IoT SiteWise Monitor portal.
Contentsid
The ID of the portal.
Type: String
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Required: Yes
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3
API Version 2019-12-02221
AWS IoT SiteWise API ReferencePortalStatus
PortalStatusContains information about the current status of a portal.
Contentserror
Contains associated error information, if any.
Type: MonitorErrorDetails (p. 220) object
Required: Nostate
The current state of the portal.
Type: String
Valid Values: CREATING | UPDATING | DELETING | ACTIVE | FAILED
Required: Yes
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3
API Version 2019-12-02222
AWS IoT SiteWise API ReferencePortalSummary
PortalSummaryContains a portal summary.
ContentscreationDate
The date the portal was created, in Unix epoch time.
Type: Timestamp
Required: Nodescription
The portal's description.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: [^\u0000-\u001F\u007F]+
Required: Noid
The ID of the portal.
Type: String
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Required: YeslastUpdateDate
The date the portal was last updated, in Unix epoch time.
Type: Timestamp
Required: Noname
The name of the portal.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: [^\u0000-\u001F\u007F]+
Required: YesroleArn
The ARN of the service role that allows the portal's users to access your AWS IoT SiteWise resourceson your behalf. For more information, see Using service roles for AWS IoT SiteWise Monitor in theAWS IoT SiteWise User Guide.
API Version 2019-12-02223
AWS IoT SiteWise API ReferenceSee Also
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
Pattern: .*
Required: NostartUrl
The public root URL for the AWS IoT AWS IoT SiteWise Monitor application portal.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: ^(http|https)\://\S+
Required: Yes
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3
API Version 2019-12-02224
AWS IoT SiteWise API ReferenceProjectResource
ProjectResourceIdentifies a specific AWS IoT SiteWise Monitor project.
Contentsid
The ID of the project.
Type: String
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Required: Yes
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3
API Version 2019-12-02225
AWS IoT SiteWise API ReferenceProjectSummary
ProjectSummaryContains project summary information.
ContentscreationDate
The date the project was created, in Unix epoch time.
Type: Timestamp
Required: Nodescription
The project's description.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: [^\u0000-\u001F\u007F]+
Required: Noid
The ID of the project.
Type: String
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Required: YeslastUpdateDate
The date the project was last updated, in Unix epoch time.
Type: Timestamp
Required: Noname
The name of the project.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: [^\u0000-\u001F\u007F]+
Required: Yes
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
API Version 2019-12-02226
AWS IoT SiteWise API ReferenceSee Also
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3
API Version 2019-12-02227
AWS IoT SiteWise API ReferenceProperty
PropertyContains asset property information.
Contentsalias
The property alias that identifies the property, such as an OPC-UA server data stream path (forexample, /company/windfarm/3/turbine/7/temperature). For more information, seeMapping Industrial Data Streams to Asset Properties in the AWS IoT SiteWise User Guide.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: [^\u0000-\u001F\u007F]+
Required: NodataType
The property data type.
Type: String
Valid Values: STRING | INTEGER | DOUBLE | BOOLEAN
Required: Yesid
The ID of the asset property.
Type: String
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Required: Yesname
The name of the property.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: [^\u0000-\u001F\u007F]+
Required: Yesnotification
The asset property's notification topic and state. For more information, see UpdateAssetProperty
Type: PropertyNotification (p. 230) object
Required: No
API Version 2019-12-02228
AWS IoT SiteWise API ReferenceSee Also
type
The property type (see PropertyType). A property contains one type.
Type: PropertyType (p. 231) object
Required: Nounit
The unit (such as Newtons or RPM) of the asset property.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: [^\u0000-\u001F\u007F]+
Required: No
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3
API Version 2019-12-02229
AWS IoT SiteWise API ReferencePropertyNotification
PropertyNotificationContains asset property value notification information. When the notification state is enabled, AWSIoT SiteWise publishes property value updates to a unique MQTT topic. For more information, seeInteracting with Other Services in the AWS IoT SiteWise User Guide.
Contentsstate
The current notification state.
Type: String
Valid Values: ENABLED | DISABLED
Required: Yestopic
The MQTT topic to which AWS IoT SiteWise publishes property value update notifications.
Type: String
Required: Yes
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3
API Version 2019-12-02230
AWS IoT SiteWise API ReferencePropertyType
PropertyTypeContains a property type, which can be one of attribute, measurement, metric, or transform.
Contentsattribute
Specifies an asset attribute property. An attribute generally contains static information, such as theserial number of an IIoT wind turbine.
Type: Attribute (p. 199) object
Required: Nomeasurement
Specifies an asset measurement property. A measurement represents a device's raw sensor datastream, such as timestamped temperature values or timestamped power values.
Type: Measurement (p. 217) object
Required: Nometric
Specifies an asset metric property. A metric contains a mathematical expression that uses aggregatefunctions to process all input data points over a time interval and output a single data point, such asto calculate the average hourly temperature.
Type: Metric (p. 218) object
Required: Notransform
Specifies an asset transform property. A transform contains a mathematical expression that mapsa property's data points from one form to another, such as a unit conversion from Celsius toFahrenheit.
Type: Transform (p. 236) object
Required: No
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3
API Version 2019-12-02231
AWS IoT SiteWise API ReferencePutAssetPropertyValueEntry
PutAssetPropertyValueEntryContains a list of value updates for an asset property in the list of asset entries consumed by theBatchPutAssetPropertyValue API.
ContentsassetId
The ID of the asset to update.
Type: String
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Required: NoentryId
The user specified ID for the entry. You can use this ID to identify which entries failed.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: ^[a-zA-Z0-9_-]+$
Required: YespropertyAlias
The property alias that identifies the property, such as an OPC-UA server data stream path (forexample, /company/windfarm/3/turbine/7/temperature). For more information, seeMapping Industrial Data Streams to Asset Properties in the AWS IoT SiteWise User Guide.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: [^\u0000-\u001F\u007F]+
Required: NopropertyId
The ID of the asset property for this entry.
Type: String
Length Constraints: Fixed length of 36.
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Required: NopropertyValues
The list of property values to upload. You can specify up to 10 propertyValues array elements.
Type: Array of AssetPropertyValue (p. 193) objects
API Version 2019-12-02232
AWS IoT SiteWise API ReferenceSee Also
Required: Yes
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3
API Version 2019-12-02233
AWS IoT SiteWise API ReferenceResource
ResourceContains an AWS IoT SiteWise Monitor resource ID for a portal or project.
Contentsportal
A portal resource.
Type: PortalResource (p. 221) object
Required: Noproject
A project resource.
Type: ProjectResource (p. 225) object
Required: No
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3
API Version 2019-12-02234
AWS IoT SiteWise API ReferenceTimeInNanos
TimeInNanosContains a timestamp with optional nanosecond granularity.
ContentsoffsetInNanos
The nanosecond offset from timeInSeconds.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 999999999.
Required: NotimeInSeconds
The timestamp date, in seconds, in the Unix epoch format. Fractional nanosecond data is providedby offsetInNanos.
Type: Long
Valid Range: Minimum value of 1. Maximum value of 31556889864403199.
Required: Yes
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3
API Version 2019-12-02235
AWS IoT SiteWise API ReferenceTransform
TransformContains an asset transform property. A transform is a one-to-one mapping of a property's data pointsfrom one form to another. For example, you can use a transform to convert a Celsius data streamto Fahrenheit by applying the transformation expression to each data point of the Celsius stream. Atransform can only have a data type of DOUBLE and consume properties with data types of INTEGER orDOUBLE.
For more information, see Transforms in the AWS IoT SiteWise User Guide.
Contentsexpression
The mathematical expression that defines the transformation function. You can specify up to 10variables per expression. You can specify up to 10 functions per expression.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern: ^[a-z0-9._+\-*%/^, ()]+$
Required: Yesvariables
The list of variables used in the expression.
Type: Array of ExpressionVariable (p. 205) objects
Required: Yes
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3
API Version 2019-12-02236
AWS IoT SiteWise API ReferenceTumblingWindow
TumblingWindowContains a tumbling window, which is a repeating fixed-sized, non-overlapping, and contiguous timeinterval. This window is used in metric and aggregation computations.
Contentsinterval
The time interval for the tumbling window. Note that w represents weeks, d represents days, hrepresents hours, and m represents minutes. AWS IoT SiteWise computes the 1w interval the end ofSunday at midnight each week (UTC), the 1d interval at the end of each day at midnight (UTC), the1h interval at the end of each hour, and so on.
When AWS IoT SiteWise aggregates data points for metric computations, the start of each interval isexclusive and the end of each interval is inclusive. AWS IoT SiteWise places the computed data pointat the end of the interval.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 3.
Pattern: 1w|1d|1h|15m|5m|1m
Required: Yes
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3
API Version 2019-12-02237
AWS IoT SiteWise API ReferenceUserIdentity
UserIdentityContains information for a user identity in an access policy.
Contentsid
The AWS SSO ID of the user.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: \S+
Required: Yes
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3
API Version 2019-12-02238
AWS IoT SiteWise API ReferenceVariableValue
VariableValueIdentifies a property value used in an expression.
ContentshierarchyId
The ID of the hierarchy to query for the property ID. You can use the hierarchy's name instead of thehierarchy's ID.
You use a hierarchy ID instead of a model ID because you can have several hierarchies using the samemodel and therefore the same propertyId. For example, you might have separately grouped assetsthat come from the same asset model. For more information, see Asset Hierarchies in the AWS IoTSiteWise User Guide.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: [^\u0000-\u001F\u007F]+
Required: NopropertyId
The ID of the property to use as the variable. You can use the property name if it's from the sameasset model.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: [^\u0000-\u001F\u007F]+
Required: Yes
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3
API Version 2019-12-02239
AWS IoT SiteWise API ReferenceVariant
VariantContains an asset property value (of a single type only).
ContentsbooleanValue
Asset property data of type Boolean (true or false).
Type: Boolean
Required: NodoubleValue
Asset property data of type double (floating point number).
Type: Double
Required: NointegerValue
Asset property data of type integer (whole number).
Type: Integer
Required: NostringValue
Asset property data of type string (sequence of characters).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern: [^\u0000-\u001F\u007F]+
Required: No
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3
API Version 2019-12-02240
AWS IoT SiteWise API Reference
Common ParametersThe following list contains the parameters that all actions use for signing Signature Version 4 requestswith a query string. Any action-specific parameters are listed in the topic for that action. For moreinformation about Signature Version 4, see Signature Version 4 Signing Process in the Amazon WebServices General Reference.
Action
The action to be performed.
Type: string
Required: YesVersion
The API version that the request is written for, expressed in the format YYYY-MM-DD.
Type: string
Required: YesX-Amz-Algorithm
The hash algorithm that you used to create the request signature.
Condition: Specify this parameter when you include authentication information in a query stringinstead of in the HTTP authorization header.
Type: string
Valid Values: AWS4-HMAC-SHA256
Required: ConditionalX-Amz-Credential
The credential scope value, which is a string that includes your access key, the date, the region youare targeting, the service you are requesting, and a termination string ("aws4_request"). The value isexpressed in the following format: access_key/YYYYMMDD/region/service/aws4_request.
For more information, see Task 2: Create a String to Sign for Signature Version 4 in the Amazon WebServices General Reference.
Condition: Specify this parameter when you include authentication information in a query stringinstead of in the HTTP authorization header.
Type: string
Required: ConditionalX-Amz-Date
The date that is used to create the signature. The format must be ISO 8601 basic format(YYYYMMDD'T'HHMMSS'Z'). For example, the following date time is a valid X-Amz-Date value:20120325T120000Z.
Condition: X-Amz-Date is optional for all requests; it can be used to override the date used forsigning requests. If the Date header is specified in the ISO 8601 basic format, X-Amz-Date is
API Version 2019-12-02241
AWS IoT SiteWise API Reference
not required. When X-Amz-Date is used, it always overrides the value of the Date header. Formore information, see Handling Dates in Signature Version 4 in the Amazon Web Services GeneralReference.
Type: string
Required: ConditionalX-Amz-Security-Token
The temporary security token that was obtained through a call to AWS Security Token Service (AWSSTS). For a list of services that support temporary security credentials from AWS Security TokenService, go to AWS Services That Work with IAM in the IAM User Guide.
Condition: If you're using temporary security credentials from the AWS Security Token Service, youmust include the security token.
Type: string
Required: ConditionalX-Amz-Signature
Specifies the hex-encoded signature that was calculated from the string to sign and the derivedsigning key.
Condition: Specify this parameter when you include authentication information in a query stringinstead of in the HTTP authorization header.
Type: string
Required: ConditionalX-Amz-SignedHeaders
Specifies all the HTTP headers that were included as part of the canonical request. For moreinformation about specifying signed headers, see Task 1: Create a Canonical Request For SignatureVersion 4 in the Amazon Web Services General Reference.
Condition: Specify this parameter when you include authentication information in a query stringinstead of in the HTTP authorization header.
Type: string
Required: Conditional
API Version 2019-12-02242
AWS IoT SiteWise API Reference
Common ErrorsThis section lists the errors common to the API actions of all AWS services. For errors specific to an APIaction for this service, see the topic for that API action.
AccessDeniedException
You do not have sufficient access to perform this action.
HTTP Status Code: 400IncompleteSignature
The request signature does not conform to AWS standards.
HTTP Status Code: 400InternalFailure
The request processing has failed because of an unknown error, exception or failure.
HTTP Status Code: 500InvalidAction
The action or operation requested is invalid. Verify that the action is typed correctly.
HTTP Status Code: 400InvalidClientTokenId
The X.509 certificate or AWS access key ID provided does not exist in our records.
HTTP Status Code: 403InvalidParameterCombination
Parameters that must not be used together were used together.
HTTP Status Code: 400InvalidParameterValue
An invalid or out-of-range value was supplied for the input parameter.
HTTP Status Code: 400InvalidQueryParameter
The AWS query string is malformed or does not adhere to AWS standards.
HTTP Status Code: 400MalformedQueryString
The query string contains a syntax error.
HTTP Status Code: 404MissingAction
The request is missing an action or a required parameter.
HTTP Status Code: 400
API Version 2019-12-02243
AWS IoT SiteWise API Reference
MissingAuthenticationToken
The request must contain either a valid (registered) AWS access key ID or X.509 certificate.
HTTP Status Code: 403MissingParameter
A required parameter for the specified action is not supplied.
HTTP Status Code: 400OptInRequired
The AWS access key ID needs a subscription for the service.
HTTP Status Code: 403RequestExpired
The request reached the service more than 15 minutes after the date stamp on the request or morethan 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stampon the request is more than 15 minutes in the future.
HTTP Status Code: 400ServiceUnavailable
The request has failed due to a temporary failure of the server.
HTTP Status Code: 503ThrottlingException
The request was denied due to request throttling.
HTTP Status Code: 400ValidationError
The input fails to satisfy the constraints specified by an AWS service.
HTTP Status Code: 400
API Version 2019-12-02244
top related