GatewayCapabilitySummary - AWS IoT SiteWise
ContentsSee Also

GatewayCapabilitySummary

Contains a summary of a gateway capability configuration.

Contents

capabilityNamespace

The namespace of the capability configuration. For example, if you configure OPC-UA sources from the AWS IoT SiteWise console, your OPC-UA capability configuration has the namespace iotsitewise:opcuacollector:version, where version is a number such as 1.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: ^[a-zA-Z]+:[a-zA-Z]+:[0-9]+$

Required: Yes

capabilitySyncStatus

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

  • IN_SYNC – The gateway is running the capability configuration.

  • NOT_APPLICABLE – Synchronization is not required for this capability configuration. This is most common when integrating partner data sources, because the data integration is handled externally by the partner.

  • OUT_OF_SYNC – The gateway hasn't received the capability configuration.

  • SYNC_FAILED – The gateway rejected the capability configuration.

  • UNKNOWN – The synchronization status is currently unknown due to an undetermined or temporary error.

Type: String

Valid Values: IN_SYNC | OUT_OF_SYNC | SYNC_FAILED | UNKNOWN | NOT_APPLICABLE

Required: Yes

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: