GatewayCapabilitySummary - Amazon IoT SiteWise
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

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 Amazon 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.

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

  • SYNC_FAILED – The gateway rejected the capability configuration.

Type: String

Valid Values: IN_SYNC | OUT_OF_SYNC | SYNC_FAILED | UNKNOWN

Required: Yes

See Also

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