Skip to content

CreateGatewayRequest

Source code in docs_src/capo_iotsitewise/types/create_gateway_request.py 
16
17
18
19
20
21
22
23
24
25
26
class CreateGatewayRequest(TypedDict, closed=True):
    gateway_name: "capo_iotsitewise.types.gateway_name.GatewayName"
    """<p>A unique name for the gateway.</p>"""
    gateway_platform: "capo_iotsitewise.types.gateway_platform.GatewayPlatform"
    """<p>The gateway's platform. You can only specify one platform in a gateway.</p>"""
    gateway_version: NotRequired[
        "capo_iotsitewise.types.gateway_version.GatewayVersion"
    ]
    """<p>The version of the gateway to create. Specify <code>3</code> to create an MQTT-enabled, V3 gateway and <code>2</code> to create a Classic streams, V2 gateway. If not specified, the default is <code>2</code> (Classic streams, V2 gateway).</p> <note> <p>When creating a V3 gateway (<code>gatewayVersion=3</code>) with the <code>GreengrassV2</code> platform, you must also specify the <code>coreDeviceOperatingSystem</code> parameter.</p> </note> <p> We recommend creating an MQTT-enabled gateway for self-hosted gateways and Siemens Industrial Edge gateways. For more information on gateway versions, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/gateways.html">Use Amazon Web Services IoT SiteWise Edge Edge gateways</a>.</p>"""
    tags: NotRequired["capo_iotsitewise.types.tag_map.TagMap"]
    """<p>A list of key-value pairs that contain metadata for the gateway. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html">Tagging your IoT SiteWise resources</a> in the <i>IoT SiteWise User Guide</i>.</p>"""

gateway_name instance-attribute 

gateway_name: GatewayName

A unique name for the gateway.

gateway_platform instance-attribute 

gateway_platform: GatewayPlatform

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

gateway_version instance-attribute 

gateway_version: NotRequired[GatewayVersion]

The version of the gateway to create. Specify 3 to create an MQTT-enabled, V3 gateway and 2 to create a Classic streams, V2 gateway. If not specified, the default is 2 (Classic streams, V2 gateway).

When creating a V3 gateway (gatewayVersion=3) with the GreengrassV2 platform, you must also specify the coreDeviceOperatingSystem parameter.

We recommend creating an MQTT-enabled gateway for self-hosted gateways and Siemens Industrial Edge gateways. For more information on gateway versions, see Use Amazon Web Services IoT SiteWise Edge Edge gateways.

tags instance-attribute 

tags: NotRequired[TagMap]

A list of key-value pairs that contain metadata for the gateway. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.