Skip to content

Commit cbdd6ed

Browse files
author
AWS
committed
AWS IoT SiteWise Update: Added support for AWS IoT SiteWise Edge. You can now create an AWS IoT SiteWise gateway that runs on AWS IoT Greengrass V2. With the gateway, you can collect local server and equipment data, process the data, and export the selected data from the edge to the AWS Cloud.
1 parent 83e1b8d commit cbdd6ed

File tree

2 files changed

+136
-4
lines changed

2 files changed

+136
-4
lines changed

‎.changes/next-release/feature-AWSIoTSiteWise-df3f67b.json

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"type": "feature",
3+
"category": "AWS IoT SiteWise",
4+
"contributor": "",
5+
"description": "Added support for AWS IoT SiteWise Edge. You can now create an AWS IoT SiteWise gateway that runs on AWS IoT Greengrass V2. With the gateway, you can collect local server and equipment data, process the data, and export the selected data from the edge to the AWS Cloud."
6+
}

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

+130-4
Original file line numberDiff line numberDiff line change
@@ -557,7 +557,7 @@
557557
{"shape":"LimitExceededException"},
558558
{"shape":"ConflictingOperationException"}
559559
],
560-
"documentation":"<p>Retrieves information about the storage configuration for IoT SiteWise.</p>",
560+
"documentation":"<p>Retrieves information about the storage configuration for IoT SiteWise.</p> <note> <p>Exporting data to Amazon S3 is currently in preview release and is subject to change. We recommend that you use this feature only with test data, and not in production environments.</p> </note>",
561561
"endpoint":{"hostPrefix":"api."}
562562
},
563563
"DisassociateAssets":{
@@ -890,7 +890,7 @@
890890
{"shape":"LimitExceededException"},
891891
{"shape":"ConflictingOperationException"}
892892
],
893-
"documentation":"<p>Configures storage settings for IoT SiteWise.</p>",
893+
"documentation":"<p>Configures storage settings for IoT SiteWise.</p> <note> <p>Exporting data to Amazon S3 is currently in preview release and is subject to change. We recommend that you use this feature only with test data, and not in production environments.</p> </note>",
894894
"endpoint":{"hostPrefix":"api."}
895895
},
896896
"TagResource":{
@@ -2044,7 +2044,8 @@
20442044
"enum":[
20452045
"IN_SYNC",
20462046
"OUT_OF_SYNC",
2047-
"SYNC_FAILED"
2047+
"SYNC_FAILED",
2048+
"UNKNOWN"
20482049
]
20492050
},
20502051
"ClientToken":{
@@ -2073,6 +2074,13 @@
20732074
},
20742075
"documentation":"<p>Contains information about a composite model property on an asset.</p>"
20752076
},
2077+
"ComputeLocation":{
2078+
"type":"string",
2079+
"enum":[
2080+
"EDGE",
2081+
"CLOUD"
2082+
]
2083+
},
20762084
"ConfigurationErrorDetails":{
20772085
"type":"structure",
20782086
"required":[
@@ -2136,6 +2144,11 @@
21362144
"error":{"httpStatusCode":409},
21372145
"exception":true
21382146
},
2147+
"CoreDeviceThingName":{
2148+
"type":"string",
2149+
"max":128,
2150+
"min":1
2151+
},
21392152
"CreateAccessPolicyRequest":{
21402153
"type":"structure",
21412154
"required":[
@@ -3359,6 +3372,36 @@
33593372
"min":1,
33603373
"pattern":"[^\\u0000-\\u001F\\u007F]+"
33613374
},
3375+
"DetailedError":{
3376+
"type":"structure",
3377+
"required":[
3378+
"code",
3379+
"message"
3380+
],
3381+
"members":{
3382+
"code":{
3383+
"shape":"DetailedErrorCode",
3384+
"documentation":"<p>The error code. </p>"
3385+
},
3386+
"message":{
3387+
"shape":"DetailedErrorMessage",
3388+
"documentation":"<p>The error message. </p>"
3389+
}
3390+
},
3391+
"documentation":"<p>Contains detailed error information. </p>"
3392+
},
3393+
"DetailedErrorCode":{
3394+
"type":"string",
3395+
"enum":[
3396+
"INCOMPATIBLE_COMPUTE_LOCATION",
3397+
"INCOMPATIBLE_FORWARDING_CONFIGURATION"
3398+
]
3399+
},
3400+
"DetailedErrorMessage":{"type":"string"},
3401+
"DetailedErrors":{
3402+
"type":"list",
3403+
"member":{"shape":"DetailedError"}
3404+
},
33623405
"DisassociateAssetsRequest":{
33633406
"type":"structure",
33643407
"required":[
@@ -3428,6 +3471,10 @@
34283471
"message":{
34293472
"shape":"ErrorMessage",
34303473
"documentation":"<p>The error message.</p>"
3474+
},
3475+
"details":{
3476+
"shape":"DetailedErrors",
3477+
"documentation":"<p> A list of detailed errors. </p>"
34313478
}
34323479
},
34333480
"documentation":"<p>Contains the details of an IoT SiteWise error.</p>"
@@ -3461,6 +3508,24 @@
34613508
"type":"list",
34623509
"member":{"shape":"ExpressionVariable"}
34633510
},
3511+
"ForwardingConfig":{
3512+
"type":"structure",
3513+
"required":["state"],
3514+
"members":{
3515+
"state":{
3516+
"shape":"ForwardingConfigState",
3517+
"documentation":"<p>The forwarding state for the given property. </p>"
3518+
}
3519+
},
3520+
"documentation":"<p>The forwarding configuration for a given property.</p>"
3521+
},
3522+
"ForwardingConfigState":{
3523+
"type":"string",
3524+
"enum":[
3525+
"DISABLED",
3526+
"ENABLED"
3527+
]
3528+
},
34643529
"GatewayCapabilitySummaries":{
34653530
"type":"list",
34663531
"member":{"shape":"GatewayCapabilitySummary"}
@@ -3485,11 +3550,14 @@
34853550
},
34863551
"GatewayPlatform":{
34873552
"type":"structure",
3488-
"required":["greengrass"],
34893553
"members":{
34903554
"greengrass":{
34913555
"shape":"Greengrass",
34923556
"documentation":"<p>A gateway that runs on IoT Greengrass.</p>"
3557+
},
3558+
"greengrassV2":{
3559+
"shape":"GreengrassV2",
3560+
"documentation":"<p>A gateway that runs on IoT Greengrass V2.</p>"
34933561
}
34943562
},
34953563
"documentation":"<p>Contains a gateway's platform information.</p>"
@@ -3515,6 +3583,7 @@
35153583
"shape":"Name",
35163584
"documentation":"<p>The name of the asset.</p>"
35173585
},
3586+
"gatewayPlatform":{"shape":"GatewayPlatform"},
35183587
"gatewayCapabilitySummaries":{
35193588
"shape":"GatewayCapabilitySummaries",
35203589
"documentation":"<p>A list of gateway capability summaries that each contain a namespace and status. Each gateway capability defines data sources for the gateway. To retrieve a capability configuration's definition, use <a href=\"https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeGatewayCapabilityConfiguration.html\">DescribeGatewayCapabilityConfiguration</a>.</p>"
@@ -3835,6 +3904,17 @@
38353904
},
38363905
"documentation":"<p>Contains details for a gateway that runs on IoT Greengrass. To create a gateway that runs on IoT Greengrass, you must add the IoT SiteWise connector to a Greengrass group and deploy it. Your Greengrass group must also have permissions to upload data to IoT SiteWise. For more information, see <a href=\"https://docs.aws.amazon.com/iot-sitewise/latest/userguide/gateway-connector.html\">Ingesting data using a gateway</a> in the <i>IoT SiteWise User Guide</i>.</p>"
38373906
},
3907+
"GreengrassV2":{
3908+
"type":"structure",
3909+
"required":["coreDeviceThingName"],
3910+
"members":{
3911+
"coreDeviceThingName":{
3912+
"shape":"CoreDeviceThingName",
3913+
"documentation":"<p>The name of the IoT thing for your IoT Greengrass V2 core device.</p>"
3914+
}
3915+
},
3916+
"documentation":"<p>Contains details for a gateway that runs on IoT Greengrass V2. To create a gateway that runs on IoT Greengrass V2, you must deploy the IoT SiteWise Edge component to your gateway device. Your <a href=\"https://docs.aws.amazon.com/greengrass/v2/developerguide/device-service-role.html\">Greengrass device role</a> must use the <code>AWSIoTSiteWiseEdgeAccess</code> policy. For more information, see <a href=\"https://docs.aws.amazon.com/iot-sitewise/latest/userguide/sw-gateways.html\">Using IoT SiteWise at the edge</a> in the <i>IoT SiteWise User Guide</i>.</p>"
3917+
},
38383918
"GroupIdentity":{
38393919
"type":"structure",
38403920
"required":["id"],
@@ -4512,9 +4592,24 @@
45124592
"Measurement":{
45134593
"type":"structure",
45144594
"members":{
4595+
"processingConfig":{
4596+
"shape":"MeasurementProcessingConfig",
4597+
"documentation":"<p>The processing configuration for the given measurement property. You can configure measurements to be kept at the edge or forwarded to the Amazon Web Services Cloud. By default, measurements are forwarded to the cloud.</p>"
4598+
}
45154599
},
45164600
"documentation":"<p>Contains an asset measurement property. For more information, see <a href=\"https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html#measurements\">Measurements</a> in the <i>IoT SiteWise User Guide</i>.</p>"
45174601
},
4602+
"MeasurementProcessingConfig":{
4603+
"type":"structure",
4604+
"required":["forwardingConfig"],
4605+
"members":{
4606+
"forwardingConfig":{
4607+
"shape":"ForwardingConfig",
4608+
"documentation":"<p>The forwarding configuration for the given measurement property. </p>"
4609+
}
4610+
},
4611+
"documentation":"<p>The processing configuration for the given measurement property. You can configure measurements to be kept at the edge or forwarded to the Amazon Web Services Cloud. By default, measurements are forwarded to the cloud.</p>"
4612+
},
45184613
"Metric":{
45194614
"type":"structure",
45204615
"required":[
@@ -4534,10 +4629,25 @@
45344629
"window":{
45354630
"shape":"MetricWindow",
45364631
"documentation":"<p>The window (time interval) over which IoT SiteWise computes the metric's aggregation expression. IoT SiteWise computes one data point per <code>window</code>.</p>"
4632+
},
4633+
"processingConfig":{
4634+
"shape":"MetricProcessingConfig",
4635+
"documentation":"<p>The processing configuration for the given metric property. You can configure metrics to be computed at the edge or in the Amazon Web Services Cloud. By default, metrics are forwarded to the cloud.</p>"
45374636
}
45384637
},
45394638
"documentation":"<p>Contains an asset metric property. With metrics, you can calculate aggregate functions, such as an average, maximum, or minimum, as specified through an expression. A metric maps several values to a single value (such as a sum).</p> <p>The maximum number of dependent/cascading variables used in any one metric calculation is 10. Therefore, a <i>root</i> metric can have up to 10 cascading metrics in its computational dependency tree. Additionally, a metric can only have a data type of <code>DOUBLE</code> and consume properties with data types of <code>INTEGER</code> or <code>DOUBLE</code>.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html#metrics\">Metrics</a> in the <i>IoT SiteWise User Guide</i>.</p>"
45404639
},
4640+
"MetricProcessingConfig":{
4641+
"type":"structure",
4642+
"required":["computeLocation"],
4643+
"members":{
4644+
"computeLocation":{
4645+
"shape":"ComputeLocation",
4646+
"documentation":"<p>The compute location for the given metric property. </p>"
4647+
}
4648+
},
4649+
"documentation":"<p>The processing configuration for the given metric property. You can configure metrics to be computed at the edge or in the Amazon Web Services Cloud. By default, metrics are forwarded to the cloud.</p>"
4650+
},
45414651
"MetricWindow":{
45424652
"type":"structure",
45434653
"members":{
@@ -5184,10 +5294,26 @@
51845294
"variables":{
51855295
"shape":"ExpressionVariables",
51865296
"documentation":"<p>The list of variables used in the expression.</p>"
5297+
},
5298+
"processingConfig":{
5299+
"shape":"TransformProcessingConfig",
5300+
"documentation":"<p>The processing configuration for the given transform property. You can configure transforms to be kept at the edge or forwarded to the Amazon Web Services Cloud. You can also configure transforms to be computed at the edge or in the cloud.</p>"
51875301
}
51885302
},
51895303
"documentation":"<p>Contains an asset transform property. A transform is a one-to-one mapping of a property's data points from one form to another. For example, you can use a transform to convert a Celsius data stream to Fahrenheit by applying the transformation expression to each data point of the Celsius stream. A transform can only have a data type of <code>DOUBLE</code> and consume properties with data types of <code>INTEGER</code> or <code>DOUBLE</code>.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html#transforms\">Transforms</a> in the <i>IoT SiteWise User Guide</i>.</p>"
51905304
},
5305+
"TransformProcessingConfig":{
5306+
"type":"structure",
5307+
"required":["computeLocation"],
5308+
"members":{
5309+
"computeLocation":{
5310+
"shape":"ComputeLocation",
5311+
"documentation":"<p>The compute location for the given transform property. </p>"
5312+
},
5313+
"forwardingConfig":{"shape":"ForwardingConfig"}
5314+
},
5315+
"documentation":"<p>The processing configuration for the given transform property. You can configure transforms to be kept at the edge or forwarded to the Amazon Web Services Cloud. You can also configure transforms to be computed at the edge or in the cloud.</p>"
5316+
},
51915317
"TraversalDirection":{
51925318
"type":"string",
51935319
"enum":[

0 commit comments

Comments
 (0)