Module Values.DescribeGatewayCapabilityConfigurationResponseSource

Each gateway capability defines data sources for a gateway. This is the namespace of the gateway capability. . The namespace follows the format service:capability:version, where: service - The service providing the capability, or iotsitewise. capability - The specific capability type. Options include: opcuacollector for the OPC UA data source collector, or publisher for data publisher capability. version - The version number of the capability. Option include 2 for Classic streams, V2 gateways, and 3 for MQTT-enabled, V3 gateways. After updating a capability configuration, the sync status becomes OUT_OF_SYNC until the gateway processes the configuration.Use DescribeGatewayCapabilityConfiguration to check the sync status and verify the configuration was applied. A gateway can have multiple capability configurations with different namespaces.

Sourcetype nonrec t = {
  1. gatewayId : ID.t option;
    (*

    The ID of the gateway that defines the capability configuration.

    *)
  2. capabilityNamespace : CapabilityNamespace.t option;
    (*

    The namespace of the gateway capability.

    *)
  3. capabilityConfiguration : CapabilityConfiguration.t option;
    (*

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

    *)
  4. capabilitySyncStatus : CapabilitySyncStatus.t option;
    (*

    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.

    *)
}
Sourcetype nonrec error = [
  1. | `InternalFailureException of InternalFailureException.t
  2. | `InvalidRequestException of InvalidRequestException.t
  3. | `ResourceNotFoundException of ResourceNotFoundException.t
  4. | `ThrottlingException of ThrottlingException.t
  5. | `Unknown_operation_error of string * string option
]
Sourceval make : ?gatewayId:??? -> ?capabilityNamespace:??? -> ?capabilityConfiguration:??? -> ?capabilitySyncStatus:??? -> unit -> t
Sourceval error_of_json : string -> Yojson.Safe.t -> [> `InternalFailureException of InternalFailureException.t | `InvalidRequestException of InvalidRequestException.t | `ResourceNotFoundException of ResourceNotFoundException.t | `ThrottlingException of ThrottlingException.t | `Unknown_operation_error of string * string option ]
Sourceval error_of_xml : string -> Awso.Xml.t -> [> `InternalFailureException of InternalFailureException.t | `InvalidRequestException of InvalidRequestException.t | `ResourceNotFoundException of ResourceNotFoundException.t | `ThrottlingException of ThrottlingException.t | `Unknown_operation_error of string * string option ]
Sourceval error_to_json : error -> Yojson.Safe.t
Sourceval to_value : t -> [> `Structure of (string * [> `Enum of string | `String of ID.t ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t