{ "uuid": "0f348e55-77f8-40c7-a281-02437deb5c1b", "lastMigration": 29, "name": "AWS IoT SiteWise", "endpointPrefix": "", "latency": 0, "port": 3000, "hostname": "", "routes": [ { "uuid": "d692adcb-713c-47fd-9816-0f5e7509add3", "documentation": "Associates a child asset with the given parent asset through a hierarchy defined in the parent asset's model. For more information, see Associating assets in the IoT SiteWise User Guide.", "method": "post", "endpoint": "assets/:assetId/associate", "responses": [ { "uuid": "40f69d6c-5e15-490b-b830-3fa49c114d9c", "body": "", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "65aefd22-d608-4713-bb19-ccd5b7da939a", "body": "\"\"", "latency": 0, "statusCode": 480, "label": "InvalidRequestException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "5bd46a19-4eed-454e-a4a1-445319deea90", "body": "\"\"", "latency": 0, "statusCode": 481, "label": "ResourceNotFoundException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "e1bc83fa-efca-4802-8532-3f46f73135e4", "body": "\"\"", "latency": 0, "statusCode": 482, "label": "InternalFailureException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "2faaa9dc-1c64-4cf0-b59b-9900007fb0e8", "body": "\"\"", "latency": 0, "statusCode": 483, "label": "LimitExceededException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "1546fc10-a762-475e-9486-6f8807137629", "body": "\"\"", "latency": 0, "statusCode": 484, "label": "ThrottlingException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "cd0eb3b6-58be-4eb3-9958-297b44ea0d05", "body": "\"\"", "latency": 0, "statusCode": 485, "label": "ConflictingOperationException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "ba511198-b1f6-4452-9020-a8b95184b0df", "documentation": "Associates a group (batch) of assets with an IoT SiteWise Monitor project.", "method": "post", "endpoint": "projects/:projectId/assets/associate", "responses": [ { "uuid": "9052be55-3469-4048-b2cf-6577ca12a0cd", "body": "{\n \"errors\": [\n {\n \"assetId\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "6091d223-5436-4a6a-9cea-ecb99b447ead", "body": "\"\"", "latency": 0, "statusCode": 480, "label": "InvalidRequestException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "580c2c60-ad0a-4713-8248-9ffabdafa4ce", "body": "\"\"", "latency": 0, "statusCode": 481, "label": "ResourceNotFoundException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "3e6cec69-70ba-447e-a1bf-4ec30e968822", "body": "\"\"", "latency": 0, "statusCode": 482, "label": "InternalFailureException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "c4473a01-c1a2-4153-aef9-86225af92066", "body": "\"\"", "latency": 0, "statusCode": 483, "label": "ThrottlingException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "cab1c2da-73aa-4fe8-b7c9-60b6d67a27c4", "body": "\"\"", "latency": 0, "statusCode": 484, "label": "LimitExceededException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "8da5ffe3-6e69-4bfb-8632-8fd4fdc433fe", "documentation": "Disassociates a group (batch) of assets from an IoT SiteWise Monitor project.", "method": "post", "endpoint": "projects/:projectId/assets/disassociate", "responses": [ { "uuid": "09259b13-fc02-4e49-962a-3a8609b31676", "body": "{\n \"errors\": [\n {\n \"assetId\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "6ba76203-906f-418f-84ad-6d04ad0f9b91", "body": "\"\"", "latency": 0, "statusCode": 480, "label": "InvalidRequestException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "81c77085-d35d-421c-975e-692a3064914c", "body": "\"\"", "latency": 0, "statusCode": 481, "label": "ResourceNotFoundException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "cec7d77a-2da8-444f-a950-39737152daab", "body": "\"\"", "latency": 0, "statusCode": 482, "label": "InternalFailureException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "538ee63b-9a92-43e5-86fa-131e6f6742bd", "body": "\"\"", "latency": 0, "statusCode": 483, "label": "ThrottlingException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "a6d3301b-9bb5-4797-9440-19b0cc1115bc", "documentation": "
Sends a list of asset property values to IoT SiteWise. Each value is a timestamp-quality-value (TQV) data point. For more information, see Ingesting data using the API in the 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.
With respect to Unix epoch time, IoT SiteWise accepts only TQVs that have a timestamp of no more than 7 days in the past and no more than 10 minutes in the future. IoT SiteWise rejects timestamps outside of the inclusive range of [-7 days, +10 minutes] and returns a TimestampOutOfRangeException
error.
For each asset property, IoT SiteWise overwrites TQVs with duplicate timestamps unless the newer TQV has a different quality. For example, if you store a TQV {T1, GOOD, V1}
, then storing {T1, GOOD, V2}
replaces the existing TQV.
IoT SiteWise authorizes access to each BatchPutAssetPropertyValue
entry individually. For more information, see BatchPutAssetPropertyValue authorization in the IoT SiteWise User Guide.
Retrieves 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, use ListAssetModels to get all of your asset model IDs. Then, use ListAssets to get all assets for each asset model.
", "method": "get", "endpoint": "assets", "responses": [ { "uuid": "783c0022-8d49-49a0-a1ad-58b02d378ae8", "body": "{\n \"assetSummaries\": [\n {\n \"id\": \"\",\n \"arn\": \"\",\n \"name\": \"\",\n \"assetModelId\": \"\",\n \"creationDate\": \"{{faker 'date.recent' 365}}\",\n \"lastUpdateDate\": \"{{faker 'date.recent' 365}}\",\n \"status\": {\n \"state\": \"\",\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n }\n },\n \"hierarchies\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n ],\n \"nextToken\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "0218c9fe-d096-4856-a894-0e5215372494", "body": "\"\"", "latency": 0, "statusCode": 480, "label": "InvalidRequestException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "a1c52c51-3802-4882-9b06-674441e7ff9f", "body": "\"\"", "latency": 0, "statusCode": 481, "label": "InternalFailureException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "7c897415-ff61-4b0f-a850-1104fe4bccd7", "body": "\"\"", "latency": 0, "statusCode": 482, "label": "ResourceNotFoundException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "21a1b16f-716d-4e42-8566-8b89d5c3015e", "body": "\"\"", "latency": 0, "statusCode": 483, "label": "ThrottlingException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "c0dec7ce-371f-4013-b7dd-3e28cba160df", "documentation": "Creates an asset model from specified property and hierarchy definitions. You create assets from asset models. With asset models, you can easily create assets of the same type that have standardized definitions. Each asset created from a model inherits the asset model's property and hierarchy definitions. For more information, see Defining asset models in the IoT SiteWise User Guide.", "method": "post", "endpoint": "asset-models", "responses": [ { "uuid": "38532f80-26a9-4898-a91a-da5091ace697", "body": "{\n \"assetModelId\": \"\",\n \"assetModelArn\": \"\",\n \"assetModelStatus\": {\n \"state\": \"\",\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n }\n }\n}", "latency": 0, "statusCode": 202, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "f6020f33-7a1e-49c2-8d30-f981cd58c7b2", "body": "\"\"", "latency": 0, "statusCode": 480, "label": "InvalidRequestException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "2c22d3ec-5638-4c45-a428-af72cf4b2444", "body": "\"\"", "latency": 0, "statusCode": 481, "label": "ResourceAlreadyExistsException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "10e0bee7-6fea-4fe9-be79-20596825d612", "body": "\"\"", "latency": 0, "statusCode": 482, "label": "ResourceNotFoundException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "c6f8a33a-45c9-43d0-9f00-94601439e33b", "body": "\"\"", "latency": 0, "statusCode": 483, "label": "InternalFailureException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "6d74f9e1-3381-4a35-9e8b-cd2b57c80ca9", "body": "\"\"", "latency": 0, "statusCode": 484, "label": "ThrottlingException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "b9410548-261f-4419-8e84-e108bd268284", "body": "\"\"", "latency": 0, "statusCode": 485, "label": "LimitExceededException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "d66e8a79-5d9f-4ebd-8b3c-8cfeede88f35", "body": "\"\"", "latency": 0, "statusCode": 486, "label": "ConflictingOperationException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "4ffaa41f-82ef-4fed-888e-a9026dc2d454", "documentation": "Retrieves a paginated list of summaries of all asset models.", "method": "get", "endpoint": "asset-models", "responses": [ { "uuid": "dbd90253-12d9-4f60-9b8a-07dd062b45a3", "body": "{\n \"assetModelSummaries\": [\n {\n \"id\": \"\",\n \"arn\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"creationDate\": \"{{faker 'date.recent' 365}}\",\n \"lastUpdateDate\": \"{{faker 'date.recent' 365}}\",\n \"status\": {\n \"state\": \"\",\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n }\n }\n }\n ],\n \"nextToken\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "41803de9-3b57-424b-88f2-f6675a4e9ed0", "body": "\"\"", "latency": 0, "statusCode": 480, "label": "InvalidRequestException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "71a4e3d5-926f-44cf-a04d-f6c7ceb963ea", "body": "\"\"", "latency": 0, "statusCode": 481, "label": "InternalFailureException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "bce50e8b-6dfa-4c02-bc06-73d0d7daeb02", "body": "\"\"", "latency": 0, "statusCode": 482, "label": "ThrottlingException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "3b68a656-68df-4800-9fdf-e57e6cb013bc", "documentation": "Creates a dashboard in an IoT SiteWise Monitor project.", "method": "post", "endpoint": "dashboards", "responses": [ { "uuid": "00d7cdd3-e10a-41df-a0f4-2269fc331a7a", "body": "{\n \"dashboardId\": \"\",\n \"dashboardArn\": \"\"\n}", "latency": 0, "statusCode": 201, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "4107c9ba-e5f8-4f88-9146-915c25043693", "body": "\"\"", "latency": 0, "statusCode": 480, "label": "InvalidRequestException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "f9e95f03-05ee-43ce-9552-2f1a0d60729d", "body": "\"\"", "latency": 0, "statusCode": 481, "label": "ResourceNotFoundException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "16be0de0-02f0-4be9-a8ca-4c442bd0cedd", "body": "\"\"", "latency": 0, "statusCode": 482, "label": "InternalFailureException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "1584b914-6af5-4bde-b4ba-e5f77a6601de", "body": "\"\"", "latency": 0, "statusCode": 483, "label": "ThrottlingException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "160a4c0c-150e-491b-bb84-805c5b43ec0e", "body": "\"\"", "latency": 0, "statusCode": 484, "label": "LimitExceededException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "57c7ce68-0cd5-4d1e-a67e-51e3411ed57a", "documentation": "Creates a gateway, which is a virtual or edge device that delivers industrial data streams from local servers to IoT SiteWise. For more information, see Ingesting data using a gateway in the IoT SiteWise User Guide.", "method": "post", "endpoint": "20200301/gateways", "responses": [ { "uuid": "d3837b63-c773-4b8a-8069-ce679efc4b8a", "body": "{\n \"gatewayId\": \"\",\n \"gatewayArn\": \"\"\n}", "latency": 0, "statusCode": 201, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "d751f916-4b7a-421f-aab5-474a56793168", "body": "\"\"", "latency": 0, "statusCode": 480, "label": "InvalidRequestException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "7b9b0ddb-a9d1-4533-9f98-0e970b0be729", "body": "\"\"", "latency": 0, "statusCode": 481, "label": "ResourceAlreadyExistsException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "114b3d26-b6af-4038-a320-db22c71cc379", "body": "\"\"", "latency": 0, "statusCode": 482, "label": "InternalFailureException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "86882b82-6001-4590-8f95-155d91399073", "body": "\"\"", "latency": 0, "statusCode": 483, "label": "ThrottlingException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "649f3f4b-00d8-41a8-9ac4-bd98be0d62c3", "body": "\"\"", "latency": 0, "statusCode": 484, "label": "LimitExceededException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f997fea3-5d22-4deb-8bd5-6b92ccf4eed1", "documentation": "Retrieves a paginated list of gateways.", "method": "get", "endpoint": "20200301/gateways", "responses": [ { "uuid": "3f6c95e9-4c07-48ea-8859-38a5b77949f0", "body": "{\n \"gatewaySummaries\": [\n {\n \"gatewayId\": \"\",\n \"gatewayName\": \"\",\n \"gatewayPlatform\": {\n \"greengrass\": {\n \"groupArn\": \"\"\n },\n \"greengrassV2\": {\n \"coreDeviceThingName\": \"\"\n }\n },\n \"gatewayCapabilitySummaries\": [\n {\n \"capabilityNamespace\": \"\",\n \"capabilitySyncStatus\": \"\"\n }\n ],\n \"creationDate\": \"{{faker 'date.recent' 365}}\",\n \"lastUpdateDate\": \"{{faker 'date.recent' 365}}\"\n }\n ],\n \"nextToken\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "3ab44be9-9f7d-4ec9-ba3e-2189a7560242", "body": "\"\"", "latency": 0, "statusCode": 480, "label": "InvalidRequestException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "d5af5d3f-806d-44b5-b5ba-98e16130ed48", "body": "\"\"", "latency": 0, "statusCode": 481, "label": "InternalFailureException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "8daebdf7-71d4-4154-8dea-d15282c2c8f9", "body": "\"\"", "latency": 0, "statusCode": 482, "label": "ThrottlingException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "60c5270b-1247-44ca-8f3d-2898c7332c72", "documentation": "Creates a portal, which can contain projects and dashboards. IoT SiteWise Monitor uses Amazon Web Services SSO or IAM to authenticate portal users and manage user permissions.
Before you can sign in to a new portal, you must add at least one identity to that portal. For more information, see Adding or removing portal administrators in the IoT SiteWise User Guide.
Deletes an asset. This action can't be undone. For more information, see Deleting assets and models in the IoT SiteWise User Guide.
You can't delete an asset that's associated to another asset. For more information, see DisassociateAssets.
Updates an asset model and all of the assets that were created from the model. Each asset created from the model inherits the updated asset model's property and hierarchy definitions. For more information, see Updating assets and models in the IoT SiteWise User Guide.
This operation overwrites the existing model with the provided model. To avoid deleting your asset model's properties or hierarchies, you must include their IDs and definitions in the updated asset model payload. For more information, see DescribeAssetModel.
If you remove a property from an asset model, IoT SiteWise deletes all previous data for that property. If you remove a hierarchy definition from an asset model, IoT SiteWise disassociates every asset associated with that hierarchy. You can't change the type or data type of an existing property.
Retrieves information about an asset property.
When you call this operation for an attribute property, this response includes the default attribute value that you define in the asset model. If you update the default value in the model, this operation's response includes the new default value.
This operation doesn't return the value of the asset property. To get the value of an asset property, use GetAssetPropertyValue.
", "method": "get", "endpoint": "assets/:assetId/properties/:propertyId", "responses": [ { "uuid": "d1551ced-7e87-4e80-af86-73b9ce074690", "body": "{\n \"assetId\": \"\",\n \"assetName\": \"\",\n \"assetModelId\": \"\",\n \"assetProperty\": {\n \"id\": \"\",\n \"name\": \"\",\n \"alias\": \"\",\n \"notification\": {\n \"topic\": \"\",\n \"state\": \"\"\n },\n \"dataType\": \"\",\n \"unit\": \"\",\n \"type\": {\n \"attribute\": {\n \"defaultValue\": \"\"\n },\n \"measurement\": {\n \"processingConfig\": {\n \"forwardingConfig\": {\n \"state\": \"\"\n }\n }\n },\n \"transform\": {\n \"expression\": \"\",\n \"variables\": [\n {\n \"name\": \"\",\n \"value\": {\n \"propertyId\": \"\",\n \"hierarchyId\": \"\"\n }\n }\n ],\n \"processingConfig\": {\n \"computeLocation\": \"\",\n \"forwardingConfig\": {\n \"state\": \"\"\n }\n }\n },\n \"metric\": {\n \"expression\": \"\",\n \"variables\": [\n {\n \"name\": \"\",\n \"value\": {\n \"propertyId\": \"\",\n \"hierarchyId\": \"\"\n }\n }\n ],\n \"window\": {\n \"tumbling\": {\n \"interval\": \"\",\n \"offset\": \"\"\n }\n },\n \"processingConfig\": {\n \"computeLocation\": \"\"\n }\n }\n }\n },\n \"compositeModel\": {\n \"name\": \"\",\n \"type\": \"\",\n \"assetProperty\": {\n \"id\": \"\",\n \"name\": \"\",\n \"alias\": \"\",\n \"notification\": {\n \"topic\": \"\",\n \"state\": \"\"\n },\n \"dataType\": \"\",\n \"unit\": \"\",\n \"type\": {\n \"attribute\": {\n \"defaultValue\": \"\"\n },\n \"measurement\": {\n \"processingConfig\": {\n \"forwardingConfig\": {\n \"state\": \"\"\n }\n }\n },\n \"transform\": {\n \"expression\": \"\",\n \"variables\": [\n {\n \"name\": \"\",\n \"value\": {\n \"propertyId\": \"\",\n \"hierarchyId\": \"\"\n }\n }\n ],\n \"processingConfig\": {\n \"computeLocation\": \"\",\n \"forwardingConfig\": {\n \"state\": \"\"\n }\n }\n },\n \"metric\": {\n \"expression\": \"\",\n \"variables\": [\n {\n \"name\": \"\",\n \"value\": {\n \"propertyId\": \"\",\n \"hierarchyId\": \"\"\n }\n }\n ],\n \"window\": {\n \"tumbling\": {\n \"interval\": \"\",\n \"offset\": \"\"\n }\n },\n \"processingConfig\": {\n \"computeLocation\": \"\"\n }\n }\n }\n }\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "dc310b72-38aa-4395-ae53-9d87217493eb", "body": "\"\"", "latency": 0, "statusCode": 480, "label": "InvalidRequestException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "4a268be8-beb0-461a-9a71-3f29e7930498", "body": "\"\"", "latency": 0, "statusCode": 481, "label": "ResourceNotFoundException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "3816beb7-9fbc-43f4-a888-4209f8486e82", "body": "\"\"", "latency": 0, "statusCode": 482, "label": "InternalFailureException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "8f2bd8e0-0c34-4588-aaa0-44dc07497a51", "body": "\"\"", "latency": 0, "statusCode": 483, "label": "ThrottlingException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "cadbb8b8-0d38-4aad-949b-91e65fe47520", "documentation": "Updates an asset property's alias and notification state.
This operation overwrites the property's existing alias and notification state. To keep your existing property's alias or notification state, you must include the existing values in the UpdateAssetProperty request. For more information, see DescribeAssetProperty.
Gets aggregated values for an asset property. For more information, see Querying aggregates in the 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.
Gets an asset property's current value. For more information, see Querying current values in the 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.
Gets the history of an asset property's values. For more information, see Querying historical values in the 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.
Get interpolated values for an asset property for a specified time interval, during a period of time. If your time series is missing data points during the specified time interval, you can use interpolation to estimate the missing data.
For example, you can use this operation to return the interpolated temperature values for a wind turbine every 24 hours over a duration of 7 days.
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.
Retrieves a paginated list of associated assets.
You can use this operation to do the following:
List child assets associated to a parent asset by a hierarchy that you specify.
List an asset's parent asset.