Skip to content

Commit 165d2cc

Browse files
author
AWS
committed
AWS IoT Events Update: API update that allows users to add AWS Iot SiteWise actions while creating Detector Model in AWS Iot Events
1 parent 4b3d7b8 commit 165d2cc

File tree

2 files changed

+226
-0
lines changed

2 files changed

+226
-0
lines changed

‎.changes/next-release/feature-AWSIoTEvents-f2e3359.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"type": "feature",
3+
"category": "AWS IoT Events",
4+
"description": "API update that allows users to add AWS Iot SiteWise actions while creating Detector Model in AWS Iot Events"
5+
}

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

Lines changed: 221 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -290,6 +290,24 @@
290290
{"shape":"ResourceInUseException"}
291291
],
292292
"documentation":"<p>Updates an input.</p>"
293+
},
294+
"VerifyResourcesExistForTagris":{
295+
"name":"VerifyResourcesExistForTagris",
296+
"http":{
297+
"method":"GET",
298+
"requestUri":"/internal/tags/resource-status"
299+
},
300+
"input":{"shape":"TagrisVerifyResourcesExistInput"},
301+
"output":{"shape":"TagrisVerifyResourcesExistOutput"},
302+
"errors":[
303+
{"shape":"TagrisAccessDeniedException"},
304+
{"shape":"TagrisInternalServiceException"},
305+
{"shape":"TagrisInvalidArnException"},
306+
{"shape":"TagrisInvalidParameterException"},
307+
{"shape":"TagrisPartialResourcesExistResultsException"},
308+
{"shape":"TagrisThrottledException"}
309+
],
310+
"internalonly":true
293311
}
294312
},
295313
"shapes":{
@@ -343,6 +361,10 @@
343361
"dynamoDBv2":{
344362
"shape":"DynamoDBv2Action",
345363
"documentation":"<p>Writes to the DynamoDB table that you created. The default action payload contains all attribute-value pairs that have the information about the detector model instance and the event that triggered the action. You can also customize the <a href=\"https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html\">payload</a>. A separate column of the DynamoDB table receives one attribute-value pair in the payload that you specify. For more information, see <a href=\"https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-event-actions.html\">Actions</a> in <i>AWS IoT Events Developer Guide</i>.</p>"
364+
},
365+
"iotSiteWise":{
366+
"shape":"IotSiteWiseAction",
367+
"documentation":"<p>Sends information about the detector model instance and the event that triggered the action to an AWS IoT SiteWise asset property.</p>"
346368
}
347369
},
348370
"documentation":"<p>An action to be performed when the <code>condition</code> is TRUE.</p>"
@@ -356,6 +378,73 @@
356378
"max":2048,
357379
"min":1
358380
},
381+
"AssetId":{"type":"string"},
382+
"AssetPropertyAlias":{"type":"string"},
383+
"AssetPropertyBooleanValue":{"type":"string"},
384+
"AssetPropertyDoubleValue":{"type":"string"},
385+
"AssetPropertyEntryId":{"type":"string"},
386+
"AssetPropertyId":{"type":"string"},
387+
"AssetPropertyIntegerValue":{"type":"string"},
388+
"AssetPropertyOffsetInNanos":{"type":"string"},
389+
"AssetPropertyQuality":{"type":"string"},
390+
"AssetPropertyStringValue":{"type":"string"},
391+
"AssetPropertyTimeInSeconds":{"type":"string"},
392+
"AssetPropertyTimestamp":{
393+
"type":"structure",
394+
"required":["timeInSeconds"],
395+
"members":{
396+
"timeInSeconds":{
397+
"shape":"AssetPropertyTimeInSeconds",
398+
"documentation":"<p>The timestamp, in seconds, in the Unix epoch format. The valid range is between 1-31556889864403199. You can also specify an expression.</p>"
399+
},
400+
"offsetInNanos":{
401+
"shape":"AssetPropertyOffsetInNanos",
402+
"documentation":"<p>The nanosecond offset converted from <code>timeInSeconds</code>. The valid range is between 0-999999999. You can also specify an expression.</p>"
403+
}
404+
},
405+
"documentation":"<p>A structure that contains timestamp information. For more information, see <a href=\"https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_TimeInNanos.html\">TimeInNanos</a> in the <i>AWS IoT SiteWise API Reference</i>.</p> <p>For parameters that are string data type, you can specify the following options:</p> <ul> <li> <p>Use a string. For example, the <code>timeInSeconds</code> value can be <code>'1586400675'</code>.</p> </li> <li> <p>Use an expression. For example, the <code>timeInSeconds</code> value can be <code>'${$input.TemperatureInput.sensorData.timestamp/1000}'</code>.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html\">Expressions</a> in the <i>AWS IoT Events Developer Guide</i>.</p> </li> </ul>"
406+
},
407+
"AssetPropertyValue":{
408+
"type":"structure",
409+
"required":["value"],
410+
"members":{
411+
"value":{
412+
"shape":"AssetPropertyVariant",
413+
"documentation":"<p>The value to send to an asset property.</p>"
414+
},
415+
"timestamp":{
416+
"shape":"AssetPropertyTimestamp",
417+
"documentation":"<p>The timestamp associated with the asset property value. The default is the current event time.</p>"
418+
},
419+
"quality":{
420+
"shape":"AssetPropertyQuality",
421+
"documentation":"<p>The quality of the asset property value. The value must be <code>GOOD</code>, <code>BAD</code>, or <code>UNCERTAIN</code>. You can also specify an expression.</p>"
422+
}
423+
},
424+
"documentation":"<p>A structure that contains value information. For more information, see <a href=\"https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_AssetPropertyValue.html\">AssetPropertyValue</a> in the <i>AWS IoT SiteWise API Reference</i>.</p> <p>For parameters that are string data type, you can specify the following options: </p> <ul> <li> <p>Use a string. For example, the <code>quality</code> value can be <code>'GOOD'</code>.</p> </li> <li> <p>Use an expression. For example, the <code>quality</code> value can be <code>$input.TemperatureInput.sensorData.quality</code> .</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html\">Expressions</a> in the <i>AWS IoT Events Developer Guide</i>.</p> </li> </ul>"
425+
},
426+
"AssetPropertyVariant":{
427+
"type":"structure",
428+
"members":{
429+
"stringValue":{
430+
"shape":"AssetPropertyStringValue",
431+
"documentation":"<p>The asset property value is a string. You can also specify an expression. If you use an expression, the evaluated result should be a string.</p>"
432+
},
433+
"integerValue":{
434+
"shape":"AssetPropertyIntegerValue",
435+
"documentation":"<p>The asset property value is an integer. You can also specify an expression. If you use an expression, the evaluated result should be an integer.</p>"
436+
},
437+
"doubleValue":{
438+
"shape":"AssetPropertyDoubleValue",
439+
"documentation":"<p>The asset property value is a double. You can also specify an expression. If you use an expression, the evaluated result should be a double.</p>"
440+
},
441+
"booleanValue":{
442+
"shape":"AssetPropertyBooleanValue",
443+
"documentation":"<p>The asset property value is a Boolean value that must be <code>TRUE</code> or <code>FALSE</code>. You can also specify an expression. If you use an expression, the evaluated result should be a Boolean value.</p>"
444+
}
445+
},
446+
"documentation":"<p>A structure that contains an asset property value. For more information, see <a href=\"https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_Variant.html\">Variant</a> in the <i>AWS IoT SiteWise API Reference</i>.</p> <important> <p>You must specify one of the following value types, depending on the <code>dataType</code> of the specified asset property. For more information, see <a href=\"https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_AssetProperty.html\">AssetProperty</a> in the <i>AWS IoT SiteWise API Reference</i>.</p> </important> <p>For parameters that are string data type, you can specify the following options:</p> <ul> <li> <p>Use a string. For example, the <code>doubleValue</code> value can be <code>'47.9'</code>.</p> </li> <li> <p>Use an expression. For example, the <code>doubleValue</code> value can be <code>$input.TemperatureInput.sensorData.temperature</code>.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html\">Expressions</a> in the <i>AWS IoT Events Developer Guide</i>.</p> </li> </ul>"
447+
},
359448
"Attribute":{
360449
"type":"structure",
361450
"required":["jsonPath"],
@@ -1044,6 +1133,33 @@
10441133
},
10451134
"documentation":"<p>Sends an AWS IoT Events input, passing in information about the detector model instance and the event that triggered the action.</p>"
10461135
},
1136+
"IotSiteWiseAction":{
1137+
"type":"structure",
1138+
"required":["propertyValue"],
1139+
"members":{
1140+
"entryId":{
1141+
"shape":"AssetPropertyEntryId",
1142+
"documentation":"<p>A unique identifier for this entry. You can use the entry ID to track which data entry causes an error in case of failure. The default is a new unique identifier. You can also specify an expression.</p>"
1143+
},
1144+
"assetId":{
1145+
"shape":"AssetId",
1146+
"documentation":"<p>The ID of the asset that has the specified property. You can specify an expression.</p>"
1147+
},
1148+
"propertyId":{
1149+
"shape":"AssetPropertyId",
1150+
"documentation":"<p>The ID of the asset property. You can specify an expression.</p>"
1151+
},
1152+
"propertyAlias":{
1153+
"shape":"AssetPropertyAlias",
1154+
"documentation":"<p>The alias of the asset property. You can also specify an expression.</p>"
1155+
},
1156+
"propertyValue":{
1157+
"shape":"AssetPropertyValue",
1158+
"documentation":"<p>The value to send to the asset property. This value contains timestamp, quality, and value (TQV) information. </p>"
1159+
}
1160+
},
1161+
"documentation":"<p>Sends information about the detector model instance and the event that triggered the action to a specified asset property in AWS IoT SiteWise.</p> <important> <p>You must specify either <code>propertyAlias</code> or both <code>assetId</code> and <code>propertyId</code> to identify the target asset property in AWS IoT SiteWise.</p> </important> <p>For parameters that are string data type, you can specify the following options: </p> <ul> <li> <p>Use a string. For example, the <code>propertyAlias</code> value can be <code>'/company/windfarm/3/turbine/7/temperature'</code>.</p> </li> <li> <p>Use an expression. For example, the <code>propertyAlias</code> value can be <code>'company/windfarm/${$input.TemperatureInput.sensorData.windfarmID}/turbine/${$input.TemperatureInput.sensorData.turbineID}/temperature'</code>.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html\">Expressions</a> in the <i>AWS IoT Events Developer Guide</i>.</p> </li> </ul>"
1162+
},
10471163
"IotTopicPublishAction":{
10481164
"type":"structure",
10491165
"required":["mqttTopic"],
@@ -1562,6 +1678,111 @@
15621678
"max":256,
15631679
"min":0
15641680
},
1681+
"TagrisAccessDeniedException":{
1682+
"type":"structure",
1683+
"members":{
1684+
"message":{"shape":"TagrisExceptionMessage"}
1685+
},
1686+
"exception":true
1687+
},
1688+
"TagrisAccountId":{
1689+
"type":"string",
1690+
"max":12,
1691+
"min":12
1692+
},
1693+
"TagrisAmazonResourceName":{
1694+
"type":"string",
1695+
"max":1011,
1696+
"min":1
1697+
},
1698+
"TagrisExceptionMessage":{
1699+
"type":"string",
1700+
"max":2048,
1701+
"min":0
1702+
},
1703+
"TagrisInternalId":{
1704+
"type":"string",
1705+
"max":64,
1706+
"min":0
1707+
},
1708+
"TagrisInternalServiceException":{
1709+
"type":"structure",
1710+
"members":{
1711+
"message":{"shape":"TagrisExceptionMessage"}
1712+
},
1713+
"exception":true,
1714+
"fault":true
1715+
},
1716+
"TagrisInvalidArnException":{
1717+
"type":"structure",
1718+
"members":{
1719+
"message":{"shape":"TagrisExceptionMessage"},
1720+
"sweepListItem":{"shape":"TagrisSweepListItem"}
1721+
},
1722+
"exception":true
1723+
},
1724+
"TagrisInvalidParameterException":{
1725+
"type":"structure",
1726+
"members":{
1727+
"message":{"shape":"TagrisExceptionMessage"}
1728+
},
1729+
"exception":true
1730+
},
1731+
"TagrisPartialResourcesExistResultsException":{
1732+
"type":"structure",
1733+
"members":{
1734+
"message":{"shape":"TagrisExceptionMessage"},
1735+
"resourceExistenceInformation":{"shape":"TagrisSweepListResult"}
1736+
},
1737+
"exception":true
1738+
},
1739+
"TagrisStatus":{
1740+
"type":"string",
1741+
"enum":[
1742+
"ACTIVE",
1743+
"NOT_ACTIVE"
1744+
]
1745+
},
1746+
"TagrisSweepList":{
1747+
"type":"list",
1748+
"member":{"shape":"TagrisSweepListItem"}
1749+
},
1750+
"TagrisSweepListItem":{
1751+
"type":"structure",
1752+
"members":{
1753+
"TagrisAccountId":{"shape":"TagrisAccountId"},
1754+
"TagrisAmazonResourceName":{"shape":"TagrisAmazonResourceName"},
1755+
"TagrisInternalId":{"shape":"TagrisInternalId"},
1756+
"TagrisVersion":{"shape":"TagrisVersion"}
1757+
}
1758+
},
1759+
"TagrisSweepListResult":{
1760+
"type":"map",
1761+
"key":{"shape":"TagrisAmazonResourceName"},
1762+
"value":{"shape":"TagrisStatus"}
1763+
},
1764+
"TagrisThrottledException":{
1765+
"type":"structure",
1766+
"members":{
1767+
"message":{"shape":"TagrisExceptionMessage"}
1768+
},
1769+
"exception":true
1770+
},
1771+
"TagrisVerifyResourcesExistInput":{
1772+
"type":"structure",
1773+
"required":["TagrisSweepList"],
1774+
"members":{
1775+
"TagrisSweepList":{"shape":"TagrisSweepList"}
1776+
}
1777+
},
1778+
"TagrisVerifyResourcesExistOutput":{
1779+
"type":"structure",
1780+
"required":["TagrisSweepListResult"],
1781+
"members":{
1782+
"TagrisSweepListResult":{"shape":"TagrisSweepListResult"}
1783+
}
1784+
},
1785+
"TagrisVersion":{"type":"long"},
15651786
"Tags":{
15661787
"type":"list",
15671788
"member":{"shape":"Tag"}

0 commit comments

Comments
 (0)