AWS IoT SiteWise

2025/03/04 - AWS IoT SiteWise - 3 updated api methods

Changes  AWS IoT SiteWise now supports MQTT-enabled, V3 gateways. Configure data destinations for real-time ingestion into AWS IoT SiteWise or buffered ingestion using Amazon S3 storage. You can also use path filters for precise data collection from specific MQTT topics.

CreateGateway (updated) Link ¶
Changes (request)
{'gatewayPlatform': {'greengrassV2': {'coreDeviceOperatingSystem': 'LINUX_AARCH64 '
                                                                   '| '
                                                                   'LINUX_AMD64 '
                                                                   '| '
                                                                   'WINDOWS_AMD64'}},
 'gatewayVersion': 'string'}

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

client.create_gateway(
    gatewayName='string',
    gatewayPlatform={
        'greengrass': {
            'groupArn': 'string'
        },
        'greengrassV2': {
            'coreDeviceThingName': 'string',
            'coreDeviceOperatingSystem': 'LINUX_AARCH64'|'LINUX_AMD64'|'WINDOWS_AMD64'
        },
        'siemensIE': {
            'iotCoreThingName': 'string'
        }
    },
    gatewayVersion='string',
    tags={
        'string': 'string'
    }
)
type gatewayName:

string

param gatewayName:

[REQUIRED]

A unique name for the gateway.

type gatewayPlatform:

dict

param gatewayPlatform:

[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 V1 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.

    • coreDeviceOperatingSystem (string) --

      The operating system of the core device in IoT Greengrass V2.

  • siemensIE (dict) --

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

    • iotCoreThingName (string) -- [REQUIRED]

      The name of the IoT Thing for your SiteWise Edge gateway.

type gatewayVersion:

string

param 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 the version isn't specified, a Classic streams, V2 gateway is created by default.

We recommend creating an MQTT-enabled, V3 gateway for self-hosted gateways. SiteWise Edge gateways on Siemens Industrial Edge should use gateway version 2. For more information on gateway versions, see Self-host a SiteWise Edge gateway with IoT Greengrass V2.

type tags:

dict

param tags:

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) --

rtype:

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 API operations.

    • gatewayArn (string) --

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

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

DescribeGateway (updated) Link ¶
Changes (response)
{'gatewayPlatform': {'greengrassV2': {'coreDeviceOperatingSystem': 'LINUX_AARCH64 '
                                                                   '| '
                                                                   'LINUX_AMD64 '
                                                                   '| '
                                                                   'WINDOWS_AMD64'}},
 'gatewayVersion': 'string'}

Retrieves information about a gateway.

See also: AWS API Documentation

Request Syntax

client.describe_gateway(
    gatewayId='string'
)
type gatewayId:

string

param gatewayId:

[REQUIRED]

The ID of the gateway device.

rtype:

dict

returns:

Response Syntax

{
    'gatewayId': 'string',
    'gatewayName': 'string',
    'gatewayArn': 'string',
    'gatewayPlatform': {
        'greengrass': {
            'groupArn': 'string'
        },
        'greengrassV2': {
            'coreDeviceThingName': 'string',
            'coreDeviceOperatingSystem': 'LINUX_AARCH64'|'LINUX_AMD64'|'WINDOWS_AMD64'
        },
        'siemensIE': {
            'iotCoreThingName': 'string'
        }
    },
    'gatewayVersion': 'string',
    'gatewayCapabilitySummaries': [
        {
            'capabilityNamespace': 'string',
            'capabilitySyncStatus': 'IN_SYNC'|'OUT_OF_SYNC'|'SYNC_FAILED'|'UNKNOWN'|'NOT_APPLICABLE'
        },
    ],
    'creationDate': datetime(2015, 1, 1),
    'lastUpdateDate': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    • gatewayId (string) --

      The ID of the gateway device.

    • gatewayName (string) --

      The name of the gateway.

    • gatewayArn (string) --

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

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

    • gatewayPlatform (dict) --

      The gateway's platform.

      • greengrass (dict) --

        A gateway that runs on IoT Greengrass.

        • groupArn (string) --

          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 V1 API Reference.

      • greengrassV2 (dict) --

        A gateway that runs on IoT Greengrass V2.

        • coreDeviceThingName (string) --

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

        • coreDeviceOperatingSystem (string) --

          The operating system of the core device in IoT Greengrass V2.

      • siemensIE (dict) --

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

        • iotCoreThingName (string) --

          The name of the IoT Thing for your SiteWise Edge gateway.

    • gatewayVersion (string) --

      The version of the gateway. A value of 3 indicates an MQTT-enabled, V3 gateway, while 2 indicates a Classic streams, V2 gateway.

    • gatewayCapabilitySummaries (list) --

      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 DescribeGatewayCapabilityConfiguration.

      • (dict) --

        Contains a summary of a gateway capability configuration.

        • capabilityNamespace (string) --

          The namespace of the capability configuration. For example, if you configure OPC-UA sources from the IoT SiteWise console, your OPC-UA capability configuration has the namespace iotsitewise:opcuacollector:version, where version is a number such as 1.

        • capabilitySyncStatus (string) --

          The synchronization status of the capability configuration. The sync status can be one of the following:

          • IN_SYNC – The gateway is running the capability configuration.

          • NOT_APPLICABLE – Synchronization is not required for this capability configuration. This is most common when integrating partner data sources, because the data integration is handled externally by the partner.

          • OUT_OF_SYNC – The gateway hasn't received the capability configuration.

          • SYNC_FAILED – The gateway rejected the capability configuration.

          • UNKNOWN – The synchronization status is currently unknown due to an undetermined or temporary error.

    • creationDate (datetime) --

      The date the gateway was created, in Unix epoch time.

    • lastUpdateDate (datetime) --

      The date the gateway was last updated, in Unix epoch time.

ListGateways (updated) Link ¶
Changes (response)
{'gatewaySummaries': {'gatewayPlatform': {'greengrassV2': {'coreDeviceOperatingSystem': 'LINUX_AARCH64 '
                                                                                        '| '
                                                                                        'LINUX_AMD64 '
                                                                                        '| '
                                                                                        'WINDOWS_AMD64'}},
                      'gatewayVersion': 'string'}}

Retrieves a paginated list of gateways.

See also: AWS API Documentation

Request Syntax

client.list_gateways(
    nextToken='string',
    maxResults=123
)
type nextToken:

string

param nextToken:

The token to be used for the next set of paginated results.

type maxResults:

integer

param maxResults:

The maximum number of results to return for each paginated request.

Default: 50

rtype:

dict

returns:

Response Syntax

{
    'gatewaySummaries': [
        {
            'gatewayId': 'string',
            'gatewayName': 'string',
            'gatewayPlatform': {
                'greengrass': {
                    'groupArn': 'string'
                },
                'greengrassV2': {
                    'coreDeviceThingName': 'string',
                    'coreDeviceOperatingSystem': 'LINUX_AARCH64'|'LINUX_AMD64'|'WINDOWS_AMD64'
                },
                'siemensIE': {
                    'iotCoreThingName': 'string'
                }
            },
            'gatewayVersion': 'string',
            'gatewayCapabilitySummaries': [
                {
                    'capabilityNamespace': 'string',
                    'capabilitySyncStatus': 'IN_SYNC'|'OUT_OF_SYNC'|'SYNC_FAILED'|'UNKNOWN'|'NOT_APPLICABLE'
                },
            ],
            'creationDate': datetime(2015, 1, 1),
            'lastUpdateDate': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • gatewaySummaries (list) --

      A list that summarizes each gateway.

      • (dict) --

        Contains a summary of a gateway.

        • gatewayId (string) --

          The ID of the gateway device.

        • gatewayName (string) --

          The name of the gateway.

        • gatewayPlatform (dict) --

          Contains a gateway's platform information.

          • greengrass (dict) --

            A gateway that runs on IoT Greengrass.

            • groupArn (string) --

              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 V1 API Reference.

          • greengrassV2 (dict) --

            A gateway that runs on IoT Greengrass V2.

            • coreDeviceThingName (string) --

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

            • coreDeviceOperatingSystem (string) --

              The operating system of the core device in IoT Greengrass V2.

          • siemensIE (dict) --

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

            • iotCoreThingName (string) --

              The name of the IoT Thing for your SiteWise Edge gateway.

        • gatewayVersion (string) --

          The version of the gateway. A value of 3 indicates an MQTT-enabled, V3 gateway, while 2 indicates a Classic streams, V2 gateway.

        • gatewayCapabilitySummaries (list) --

          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 DescribeGatewayCapabilityConfiguration.

          • (dict) --

            Contains a summary of a gateway capability configuration.

            • capabilityNamespace (string) --

              The namespace of the capability configuration. For example, if you configure OPC-UA sources from the IoT SiteWise console, your OPC-UA capability configuration has the namespace iotsitewise:opcuacollector:version, where version is a number such as 1.

            • capabilitySyncStatus (string) --

              The synchronization status of the capability configuration. The sync status can be one of the following:

              • IN_SYNC – The gateway is running the capability configuration.

              • NOT_APPLICABLE – Synchronization is not required for this capability configuration. This is most common when integrating partner data sources, because the data integration is handled externally by the partner.

              • OUT_OF_SYNC – The gateway hasn't received the capability configuration.

              • SYNC_FAILED – The gateway rejected the capability configuration.

              • UNKNOWN – The synchronization status is currently unknown due to an undetermined or temporary error.

        • creationDate (datetime) --

          The date the gateway was created, in Unix epoch time.

        • lastUpdateDate (datetime) --

          The date the gateway was last updated, in Unix epoch time.

    • nextToken (string) --

      The token for the next set of results, or null if there are no additional results.