IoTSiteWise / Client / create_gateway

create_gateway

IoTSiteWise.Client.create_gateway(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.create_gateway(
    gatewayName='string',
    gatewayPlatform={
        'greengrass': {
            'groupArn': 'string'
        },
        'greengrassV2': {
            'coreDeviceThingName': 'string'
        }
    },
    tags={
        'string': 'string'
    }
)

Parameters:

• gatewayName (string) –

  [REQUIRED]

  A unique, friendly name for the gateway.

• gatewayPlatform (dict) –

  [REQUIRED]

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

  • greengrass (dict) –

    A gateway that runs on IoT Greengrass.

    • groupArn (string) – [REQUIRED]

      The ARN of the Greengrass group. For more information about how to find a group’s ARN, see ListGroups and GetGroup in the IoT Greengrass API Reference.

  • greengrassV2 (dict) –

    A gateway that runs on IoT Greengrass V2.

    • coreDeviceThingName (string) – [REQUIRED]

      The name of the IoT thing for your IoT Greengrass V2 core device.

• tags (dict) –

  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.

  • (string) –

    • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'gatewayId': 'string',
    'gatewayArn': 'string'
}

Response Structure

• (dict) –

  • gatewayId (string) –

    The ID of the gateway device. You can use this ID when you call other IoT SiteWise APIs.

  • gatewayArn (string) –

    The ARN of the gateway, which has the following format.

    arn:${Partition}:iotsitewise:${Region}:${Account}:gateway/${GatewayId}

Exceptions

• IoTSiteWise.Client.exceptions.InvalidRequestException

• IoTSiteWise.Client.exceptions.ResourceAlreadyExistsException

• IoTSiteWise.Client.exceptions.InternalFailureException

• IoTSiteWise.Client.exceptions.ThrottlingException

• IoTSiteWise.Client.exceptions.LimitExceededException