Skip to content

UpdateGatewayCapabilityConfigurationResponse

Source code in docs_src/capo_iotsitewise/types/update_gateway_capability_configuration_response.py 
14
15
16
17
18
19
20
21
22
class UpdateGatewayCapabilityConfigurationResponse(TypedDict, closed=True):
    capability_namespace: (
        "capo_iotsitewise.types.capability_namespace.CapabilityNamespace"
    )
    """<p>The namespace of the gateway capability.</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> <p>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.</p>"""

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.

After you update a capability configuration, its sync status is OUT_OF_SYNC until the gateway receives and applies or rejects the updated configuration.