2024/07/24 - AWS IoT SiteWise - 5 updated api methods
Changes Adds support for creating SiteWise Edge gateways that run on a Siemens Industrial Edge Device.
{'gatewayPlatform': {'siemensIE': {'iotCoreThingName': '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'
},
'siemensIE': {
'iotCoreThingName': 'string'
}
},
tags={
'string': 'string'
}
)
string
[REQUIRED]
A unique name for the gateway.
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 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.
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.
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) --
dict
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}
{'gatewayCapabilitySummaries': {'capabilitySyncStatus': {'NOT_APPLICABLE'}},
'gatewayPlatform': {'siemensIE': {'iotCoreThingName': 'string'}}}
Retrieves information about a gateway.
See also: AWS API Documentation
Request Syntax
client.describe_gateway(
gatewayId='string'
)
string
[REQUIRED]
The ID of the gateway device.
dict
Response Syntax
{
'gatewayId': 'string',
'gatewayName': 'string',
'gatewayArn': '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)
}
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.
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.
OUT_OF_SYNC – The gateway hasn't received the capability configuration.
SYNC_FAILED – The gateway rejected the capability configuration.
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.
{'capabilitySyncStatus': {'NOT_APPLICABLE'}}
Retrieves information about a gateway capability configuration. Each gateway capability defines data sources for a gateway. A capability configuration can contain multiple data source configurations. If you define OPC-UA sources for a gateway in the IoT SiteWise console, all of your OPC-UA sources are stored in one capability configuration. To list all capability configurations for a gateway, use DescribeGateway.
See also: AWS API Documentation
Request Syntax
client.describe_gateway_capability_configuration(
gatewayId='string',
capabilityNamespace='string'
)
string
[REQUIRED]
The ID of the gateway that defines the capability configuration.
string
[REQUIRED]
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.
dict
Response Syntax
{
'gatewayId': 'string',
'capabilityNamespace': 'string',
'capabilityConfiguration': 'string',
'capabilitySyncStatus': 'IN_SYNC'|'OUT_OF_SYNC'|'SYNC_FAILED'|'UNKNOWN'|'NOT_APPLICABLE'
}
Response Structure
(dict) --
gatewayId (string) --
The ID of the gateway that defines the capability configuration.
capabilityNamespace (string) --
The namespace of the gateway capability.
capabilityConfiguration (string) --
The JSON document that defines the gateway capability's configuration. For more information, see Configuring data sources (CLI) in the IoT SiteWise User Guide.
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.
OUT_OF_SYNC – The gateway hasn't received the capability configuration.
SYNC_FAILED – The gateway rejected the capability configuration.
{'gatewaySummaries': {'gatewayCapabilitySummaries': {'capabilitySyncStatus': {'NOT_APPLICABLE'}},
'gatewayPlatform': {'siemensIE': {'iotCoreThingName': 'string'}}}}
Retrieves a paginated list of gateways.
See also: AWS API Documentation
Request Syntax
client.list_gateways(
nextToken='string',
maxResults=123
)
string
The token to be used for the next set of paginated results.
integer
The maximum number of results to return for each paginated request.
Default: 50
dict
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.
OUT_OF_SYNC – The gateway hasn't received the capability configuration.
SYNC_FAILED – The gateway rejected the capability configuration.
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.
{'capabilitySyncStatus': {'NOT_APPLICABLE'}}
Updates a gateway capability configuration or defines a new capability configuration. Each gateway capability defines data sources for a gateway. A capability configuration can contain multiple data source configurations. If you define OPC-UA sources for a gateway in the IoT SiteWise console, all of your OPC-UA sources are stored in one capability configuration. To list all capability configurations for a gateway, use DescribeGateway.
See also: AWS API Documentation
Request Syntax
client.update_gateway_capability_configuration(
gatewayId='string',
capabilityNamespace='string',
capabilityConfiguration='string'
)
string
[REQUIRED]
The ID of the gateway to be updated.
string
[REQUIRED]
The namespace of the gateway capability configuration to be updated. 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.
string
[REQUIRED]
The JSON document that defines the configuration for the gateway capability. For more information, see Configuring data sources (CLI) in the IoT SiteWise User Guide.
dict
Response Syntax
{
'capabilityNamespace': 'string',
'capabilitySyncStatus': 'IN_SYNC'|'OUT_OF_SYNC'|'SYNC_FAILED'|'UNKNOWN'|'NOT_APPLICABLE'
}
Response Structure
(dict) --
capabilityNamespace (string) --
The namespace of the gateway capability.
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.
OUT_OF_SYNC – The gateway hasn't received the capability configuration.
SYNC_FAILED – The gateway rejected the capability configuration.
After you update a capability configuration, its sync status is OUT_OF_SYNC until the gateway receives and applies or rejects the updated configuration.