GatewayPlatform - Amazon IoT SiteWise
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

GatewayPlatform

The gateway's platform configuration. You can only specify one platform type in a gateway.

(Legacy only) For Greengrass V1 gateways, specify the greengrass parameter with a valid Greengrass group ARN.

For Greengrass V2 gateways, specify the greengrassV2 parameter with a valid core device thing name. If creating a V3 gateway (gatewayVersion=3), you must also specify the coreDeviceOperatingSystem.

For Siemens Industrial Edge gateways, specify the siemensIE parameter with a valid IoT Core thing name.

Contents

greengrass

A gateway that runs on Amazon IoT Greengrass.

Type: Greengrass object

Required: No

greengrassV2

A gateway that runs on Amazon IoT Greengrass V2.

Type: GreengrassV2 object

Required: No

siemensIE

A SiteWise Edge gateway that runs on a Siemens Industrial Edge Device.

Type: SiemensIE object

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: