Post 20200301gatewaysgatewayidcapability — iotsitewise

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1473397365.8 KB

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 <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeGateway.html">DescribeGateway</a>.

post/20200301/gateways/{gatewayId}/capability

Path parameters

gatewayIdstring required

The ID of the gateway to be updated.

Request body

capabilityNamespacestring 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 <code>iotsitewise:opcuacollector:version</code>, where <code>version</code> is a number such as <code>1</code>.

capabilityConfigurationstring required

The JSON document that defines the configuration for the gateway capability. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/configure-sources.html#configure-source-cli">Configuring data sources (CLI)</a> in the IoT SiteWise User Guide.

Response

Success

capabilityNamespacestring required

The namespace of the gateway capability.

capabilitySyncStatus'IN_SYNC' | 'OUT_OF_SYNC' | 'SYNC_FAILED' | 'UNKNOWN' required

The synchronization status of the capability configuration. The sync status can be one of the following: <ul> <li> <code>IN_SYNC</code> – The gateway is running the capability configuration. </li> <li> <code>OUT_OF_SYNC</code> – The gateway hasn't received the capability configuration. </li> <li> <code>SYNC_FAILED</code> – The gateway rejected the capability configuration. </li> </ul> After you update a capability configuration, its sync status is <code>OUT_OF_SYNC</code> until the gateway receives and applies or rejects the updated configuration.