libZSservicesZSamazonka-iotsitewiseZSamazonka-iotsitewise
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.IoTSiteWise.Types.GatewayCapabilitySummary

Description

 
Synopsis

Documentation

data GatewayCapabilitySummary Source #

Contains a summary of a gateway capability configuration.

See: newGatewayCapabilitySummary smart constructor.

Constructors

GatewayCapabilitySummary' 

Fields

  • capabilityNamespace :: Text

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

  • capabilitySyncStatus :: 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.

Instances

Instances details
Eq GatewayCapabilitySummary Source # 
Instance details

Defined in Amazonka.IoTSiteWise.Types.GatewayCapabilitySummary

Read GatewayCapabilitySummary Source # 
Instance details

Defined in Amazonka.IoTSiteWise.Types.GatewayCapabilitySummary

Show GatewayCapabilitySummary Source # 
Instance details

Defined in Amazonka.IoTSiteWise.Types.GatewayCapabilitySummary

Generic GatewayCapabilitySummary Source # 
Instance details

Defined in Amazonka.IoTSiteWise.Types.GatewayCapabilitySummary

Associated Types

type Rep GatewayCapabilitySummary :: Type -> Type #

NFData GatewayCapabilitySummary Source # 
Instance details

Defined in Amazonka.IoTSiteWise.Types.GatewayCapabilitySummary

Hashable GatewayCapabilitySummary Source # 
Instance details

Defined in Amazonka.IoTSiteWise.Types.GatewayCapabilitySummary

FromJSON GatewayCapabilitySummary Source # 
Instance details

Defined in Amazonka.IoTSiteWise.Types.GatewayCapabilitySummary

type Rep GatewayCapabilitySummary Source # 
Instance details

Defined in Amazonka.IoTSiteWise.Types.GatewayCapabilitySummary

type Rep GatewayCapabilitySummary = D1 ('MetaData "GatewayCapabilitySummary" "Amazonka.IoTSiteWise.Types.GatewayCapabilitySummary" "libZSservicesZSamazonka-iotsitewiseZSamazonka-iotsitewise" 'False) (C1 ('MetaCons "GatewayCapabilitySummary'" 'PrefixI 'True) (S1 ('MetaSel ('Just "capabilityNamespace") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "capabilitySyncStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 CapabilitySyncStatus)))

newGatewayCapabilitySummary Source #

Create a value of GatewayCapabilitySummary with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

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

$sel:capabilitySyncStatus:GatewayCapabilitySummary', gatewayCapabilitySummary_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.

gatewayCapabilitySummary_capabilityNamespace :: Lens' GatewayCapabilitySummary Text Source #

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

gatewayCapabilitySummary_capabilitySyncStatus :: Lens' GatewayCapabilitySummary CapabilitySyncStatus Source #

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.