Amazon IoT SiteWise · Schema
DescribeGatewayCapabilityConfigurationResponse
DescribeGatewayCapabilityConfigurationResponse schema
Asset ManagementIndustrial IoTIoTTime Series Data
Properties
| Name | Type | Description |
|---|---|---|
| gatewayId | object | |
| capabilityNamespace | object | |
| capabilityConfiguration | object | |
| capabilitySyncStatus | object |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/amazon-iot-sitewise/refs/heads/main/json-schema/iot-sitewise-describe-gateway-capability-configuration-response-schema.json",
"title": "DescribeGatewayCapabilityConfigurationResponse",
"description": "DescribeGatewayCapabilityConfigurationResponse schema",
"type": "object",
"properties": {
"gatewayId": {
"allOf": [
{
"$ref": "#/components/schemas/ID"
},
{
"description": "The ID of the gateway that defines the capability configuration."
}
]
},
"capabilityNamespace": {
"allOf": [
{
"$ref": "#/components/schemas/CapabilityNamespace"
},
{
"description": "The namespace of the gateway capability."
}
]
},
"capabilityConfiguration": {
"allOf": [
{
"$ref": "#/components/schemas/CapabilityConfiguration"
},
{
"description": "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": {
"allOf": [
{
"$ref": "#/components/schemas/CapabilitySyncStatus"
},
{
"description": "<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> \u2013 The gateway is running the capability configuration.</p> </li> <li> <p> <code>OUT_OF_SYNC</code> \u2013 The gateway hasn't received the capability configuration.</p> </li> <li> <p> <code>SYNC_FAILED</code> \u2013 The gateway rejected the capability configuration.</p> </li> </ul>"
}
]
}
},
"required": [
"gatewayId",
"capabilityNamespace",
"capabilityConfiguration",
"capabilitySyncStatus"
]
}