IoTSiteWise / Client / list_gateways

list_gateways#

IoTSiteWise.Client.list_gateways(**kwargs)#

Retrieves a paginated list of gateways.

See also: AWS API Documentation

Request Syntax

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

  • nextToken (string) – The token to be used for the next set of paginated results.

  • maxResults (integer) –

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

    Default: 50

Return type:

dict

Returns:

Response Syntax

{
    'gatewaySummaries': [
        {
            'gatewayId': 'string',
            'gatewayName': 'string',
            'gatewayPlatform': {
                'greengrass': {
                    'groupArn': 'string'
                },
                'greengrassV2': {
                    'coreDeviceThingName': 'string'
                },
                'siemensIE': {
                    'iotCoreThingName': '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.

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

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

Exceptions