Skip to content

DescribeGatewayCapabilityConfigurationResponse

Source code in docs_src/capo_iotsitewise/types/describe_gateway_capability_configuration_response.py
class DescribeGatewayCapabilityConfigurationResponse(TypedDict, closed=True):
    gateway_id: "capo_iotsitewise.types.id.ID"
    """<p>The ID of the gateway that defines the capability configuration.</p>"""
    capability_namespace: (
        "capo_iotsitewise.types.capability_namespace.CapabilityNamespace"
    )
    """<p>The namespace of the gateway capability.</p>"""
    capability_configuration: (
        "capo_iotsitewise.types.capability_configuration.CapabilityConfiguration"
    )
    """<p>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>.</p>"""
    capability_sync_status: (
        "capo_iotsitewise.types.capability_sync_status.CapabilitySyncStatus"
    )
    """<p>The synchronization status of the gateway capability configuration. The sync status can be one of the following:</p> <ul> <li> <p> <code>IN_SYNC</code> - The gateway is running with the latest configuration.</p> </li> <li> <p> <code>OUT_OF_SYNC</code> - The gateway hasn't received the latest configuration.</p> </li> <li> <p> <code>SYNC_FAILED</code> - The gateway rejected the latest configuration.</p> </li> <li> <p> <code>UNKNOWN</code> - The gateway hasn't reported its sync status.</p> </li> <li> <p> <code>NOT_APPLICABLE</code> - The gateway doesn't support this capability. This is most common when integrating partner data sources, because the data integration is handled externally by the partner.</p> </li> </ul>"""

capability_configuration instance-attribute

capability_configuration: CapabilityConfiguration

The JSON document that defines the gateway capability's configuration. For more information, see Configuring data sources (CLI) in the IoT SiteWise User Guide.

capability_namespace instance-attribute

capability_namespace: CapabilityNamespace

The namespace of the gateway capability.

capability_sync_status instance-attribute

capability_sync_status: CapabilitySyncStatus

The synchronization status of the gateway capability configuration. The sync status can be one of the following:

  • IN_SYNC - The gateway is running with the latest configuration.

  • OUT_OF_SYNC - The gateway hasn't received the latest configuration.

  • SYNC_FAILED - The gateway rejected the latest configuration.

  • UNKNOWN - The gateway hasn't reported its sync status.

  • NOT_APPLICABLE - The gateway doesn't support this capability. This is most common when integrating partner data sources, because the data integration is handled externally by the partner.

gateway_id instance-attribute

gateway_id: ID

The ID of the gateway that defines the capability configuration.