Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1473397365.8 KB

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

get/20200301/gateways/{gatewayId}/capability/{capabilityNamespace}

Path parameters

gatewayIdstring required

The ID of the gateway that defines the capability configuration.

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

Response

Success

gatewayIdstring required

The ID of the gateway that defines the capability configuration.

capabilityNamespacestring required

The namespace of the gateway capability.

capabilityConfigurationstring required

The JSON document that defines the gateway capability's configuration. 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 <i>IoT SiteWise User Guide</i>.

capabilitySyncStatus'IN_SYNC' | 'OUT_OF_SYNC' | 'SYNC_FAILED' | 'UNKNOWN' required
<p>The synchronization status of the capability configuration. The sync status can be one of the following:</p> <ul> <li> <p> <code>IN_SYNC</code> – The gateway is running the capability configuration.</p> </li> <li> <p> <code>OUT_OF_SYNC</code> – The gateway hasn't received the capability configuration.</p> </li> <li> <p> <code>SYNC_FAILED</code> – The gateway rejected the capability configuration.</p> </li> </ul>