Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.IoTSiteWise.UpdateGatewayCapabilityConfiguration

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates a gateway capability configuration or defines a new capability configuration. Each gateway capability defines data sources for a gateway. A capability configuration can contain multiple data source configurations. If you define OPC-UA sources for a gateway in the IoT SiteWise console, all of your OPC-UA sources are stored in one capability configuration. To list all capability configurations for a gateway, use DescribeGateway.

Synopsis

Creating a Request

data UpdateGatewayCapabilityConfiguration Source #

See: newUpdateGatewayCapabilityConfiguration smart constructor.

Constructors

UpdateGatewayCapabilityConfiguration'

Fields

gatewayId :: Text
The ID of the gateway to be updated.
capabilityNamespace :: Text
The namespace of the gateway capability configuration to be updated. 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.
capabilityConfiguration :: Text
The JSON document that defines the configuration for the gateway capability. For more information, see Configuring data sources (CLI) in the IoT SiteWise User Guide.

Instances

Instances details

Eq UpdateGatewayCapabilityConfiguration Source #
Instance details Defined in Amazonka.IoTSiteWise.UpdateGatewayCapabilityConfiguration Methods (==) :: UpdateGatewayCapabilityConfiguration -> UpdateGatewayCapabilityConfiguration -> Bool # (/=) :: UpdateGatewayCapabilityConfiguration -> UpdateGatewayCapabilityConfiguration -> Bool #
Read UpdateGatewayCapabilityConfiguration Source #
Instance details Defined in Amazonka.IoTSiteWise.UpdateGatewayCapabilityConfiguration Methods readsPrec :: Int -> ReadS UpdateGatewayCapabilityConfiguration # readList :: ReadS [UpdateGatewayCapabilityConfiguration] # readPrec :: ReadPrec UpdateGatewayCapabilityConfiguration # readListPrec :: ReadPrec [UpdateGatewayCapabilityConfiguration] #
Show UpdateGatewayCapabilityConfiguration Source #
Instance details Defined in Amazonka.IoTSiteWise.UpdateGatewayCapabilityConfiguration Methods showsPrec :: Int -> UpdateGatewayCapabilityConfiguration -> ShowS # show :: UpdateGatewayCapabilityConfiguration -> String # showList :: [UpdateGatewayCapabilityConfiguration] -> ShowS #
Generic UpdateGatewayCapabilityConfiguration Source #
Instance details Defined in Amazonka.IoTSiteWise.UpdateGatewayCapabilityConfiguration Associated Types type Rep UpdateGatewayCapabilityConfiguration :: Type -> Type # Methods from :: UpdateGatewayCapabilityConfiguration -> Rep UpdateGatewayCapabilityConfiguration x # to :: Rep UpdateGatewayCapabilityConfiguration x -> UpdateGatewayCapabilityConfiguration #
NFData UpdateGatewayCapabilityConfiguration Source #
Instance details Defined in Amazonka.IoTSiteWise.UpdateGatewayCapabilityConfiguration Methods rnf :: UpdateGatewayCapabilityConfiguration -> () #
Hashable UpdateGatewayCapabilityConfiguration Source #
Instance details Defined in Amazonka.IoTSiteWise.UpdateGatewayCapabilityConfiguration Methods hashWithSalt :: Int -> UpdateGatewayCapabilityConfiguration -> Int # hash :: UpdateGatewayCapabilityConfiguration -> Int #
ToJSON UpdateGatewayCapabilityConfiguration Source #
Instance details Defined in Amazonka.IoTSiteWise.UpdateGatewayCapabilityConfiguration Methods toJSON :: UpdateGatewayCapabilityConfiguration -> Value # toEncoding :: UpdateGatewayCapabilityConfiguration -> Encoding # toJSONList :: [UpdateGatewayCapabilityConfiguration] -> Value # toEncodingList :: [UpdateGatewayCapabilityConfiguration] -> Encoding #
AWSRequest UpdateGatewayCapabilityConfiguration Source #
Instance details Defined in Amazonka.IoTSiteWise.UpdateGatewayCapabilityConfiguration Associated Types type AWSResponse UpdateGatewayCapabilityConfiguration # Methods request :: UpdateGatewayCapabilityConfiguration -> Request UpdateGatewayCapabilityConfiguration # response :: MonadResource m => Logger -> Service -> Proxy UpdateGatewayCapabilityConfiguration -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateGatewayCapabilityConfiguration))) #
ToHeaders UpdateGatewayCapabilityConfiguration Source #
Instance details Defined in Amazonka.IoTSiteWise.UpdateGatewayCapabilityConfiguration Methods toHeaders :: UpdateGatewayCapabilityConfiguration -> [Header] #
ToPath UpdateGatewayCapabilityConfiguration Source #
Instance details Defined in Amazonka.IoTSiteWise.UpdateGatewayCapabilityConfiguration Methods toPath :: UpdateGatewayCapabilityConfiguration -> ByteString #
ToQuery UpdateGatewayCapabilityConfiguration Source #
Instance details Defined in Amazonka.IoTSiteWise.UpdateGatewayCapabilityConfiguration Methods toQuery :: UpdateGatewayCapabilityConfiguration -> QueryString #
type Rep UpdateGatewayCapabilityConfiguration Source #
Instance details Defined in Amazonka.IoTSiteWise.UpdateGatewayCapabilityConfiguration type Rep UpdateGatewayCapabilityConfiguration = D1 ('MetaData "UpdateGatewayCapabilityConfiguration" "Amazonka.IoTSiteWise.UpdateGatewayCapabilityConfiguration" "libZSservicesZSamazonka-iotsitewiseZSamazonka-iotsitewise" 'False) (C1 ('MetaCons "UpdateGatewayCapabilityConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "gatewayId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "capabilityNamespace") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "capabilityConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse UpdateGatewayCapabilityConfiguration Source #
Instance details Defined in Amazonka.IoTSiteWise.UpdateGatewayCapabilityConfiguration type AWSResponse UpdateGatewayCapabilityConfiguration = UpdateGatewayCapabilityConfigurationResponse

newUpdateGatewayCapabilityConfiguration Source #

Arguments

:: Text	`$sel:gatewayId:UpdateGatewayCapabilityConfiguration'`
-> Text	`$sel:capabilityNamespace:UpdateGatewayCapabilityConfiguration'`
-> Text	`$sel:capabilityConfiguration:UpdateGatewayCapabilityConfiguration'`
-> UpdateGatewayCapabilityConfiguration

Create a value of UpdateGatewayCapabilityConfiguration 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:gatewayId:UpdateGatewayCapabilityConfiguration', updateGatewayCapabilityConfiguration_gatewayId - The ID of the gateway to be updated.

$sel:capabilityNamespace:UpdateGatewayCapabilityConfiguration', updateGatewayCapabilityConfiguration_capabilityNamespace - The namespace of the gateway capability configuration to be updated. 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:capabilityConfiguration:UpdateGatewayCapabilityConfiguration', updateGatewayCapabilityConfiguration_capabilityConfiguration - The JSON document that defines the configuration for the gateway capability. For more information, see Configuring data sources (CLI) in the IoT SiteWise User Guide.

Request Lenses

updateGatewayCapabilityConfiguration_gatewayId :: Lens' UpdateGatewayCapabilityConfiguration Text Source #

The ID of the gateway to be updated.

updateGatewayCapabilityConfiguration_capabilityNamespace :: Lens' UpdateGatewayCapabilityConfiguration Text Source #

The namespace of the gateway capability configuration to be updated. 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.

updateGatewayCapabilityConfiguration_capabilityConfiguration :: Lens' UpdateGatewayCapabilityConfiguration Text Source #

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

Destructuring the Response

data UpdateGatewayCapabilityConfigurationResponse Source #

See: newUpdateGatewayCapabilityConfigurationResponse smart constructor.

Constructors

UpdateGatewayCapabilityConfigurationResponse'

Fields

httpStatus :: Int
The response's http status code.
capabilityNamespace :: Text
The namespace of the gateway capability.
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.
After you update a capability configuration, its sync status is OUT_OF_SYNC until the gateway receives and applies or rejects the updated configuration.

Instances

Instances details

Eq UpdateGatewayCapabilityConfigurationResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.UpdateGatewayCapabilityConfiguration Methods (==) :: UpdateGatewayCapabilityConfigurationResponse -> UpdateGatewayCapabilityConfigurationResponse -> Bool # (/=) :: UpdateGatewayCapabilityConfigurationResponse -> UpdateGatewayCapabilityConfigurationResponse -> Bool #
Read UpdateGatewayCapabilityConfigurationResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.UpdateGatewayCapabilityConfiguration Methods readsPrec :: Int -> ReadS UpdateGatewayCapabilityConfigurationResponse # readList :: ReadS [UpdateGatewayCapabilityConfigurationResponse] # readPrec :: ReadPrec UpdateGatewayCapabilityConfigurationResponse # readListPrec :: ReadPrec [UpdateGatewayCapabilityConfigurationResponse] #
Show UpdateGatewayCapabilityConfigurationResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.UpdateGatewayCapabilityConfiguration Methods showsPrec :: Int -> UpdateGatewayCapabilityConfigurationResponse -> ShowS # show :: UpdateGatewayCapabilityConfigurationResponse -> String # showList :: [UpdateGatewayCapabilityConfigurationResponse] -> ShowS #
Generic UpdateGatewayCapabilityConfigurationResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.UpdateGatewayCapabilityConfiguration Associated Types type Rep UpdateGatewayCapabilityConfigurationResponse :: Type -> Type # Methods from :: UpdateGatewayCapabilityConfigurationResponse -> Rep UpdateGatewayCapabilityConfigurationResponse x # to :: Rep UpdateGatewayCapabilityConfigurationResponse x -> UpdateGatewayCapabilityConfigurationResponse #
NFData UpdateGatewayCapabilityConfigurationResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.UpdateGatewayCapabilityConfiguration Methods rnf :: UpdateGatewayCapabilityConfigurationResponse -> () #
type Rep UpdateGatewayCapabilityConfigurationResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.UpdateGatewayCapabilityConfiguration type Rep UpdateGatewayCapabilityConfigurationResponse = D1 ('MetaData "UpdateGatewayCapabilityConfigurationResponse" "Amazonka.IoTSiteWise.UpdateGatewayCapabilityConfiguration" "libZSservicesZSamazonka-iotsitewiseZSamazonka-iotsitewise" 'False) (C1 ('MetaCons "UpdateGatewayCapabilityConfigurationResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: (S1 ('MetaSel ('Just "capabilityNamespace") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "capabilitySyncStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 CapabilitySyncStatus))))

newUpdateGatewayCapabilityConfigurationResponse Source #

Arguments

:: Int	`$sel:httpStatus:UpdateGatewayCapabilityConfigurationResponse'`
-> Text	`$sel:capabilityNamespace:UpdateGatewayCapabilityConfiguration'`
-> CapabilitySyncStatus	`$sel:capabilitySyncStatus:UpdateGatewayCapabilityConfigurationResponse'`
-> UpdateGatewayCapabilityConfigurationResponse

Create a value of UpdateGatewayCapabilityConfigurationResponse 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:httpStatus:UpdateGatewayCapabilityConfigurationResponse', updateGatewayCapabilityConfigurationResponse_httpStatus - The response's http status code.

$sel:capabilityNamespace:UpdateGatewayCapabilityConfiguration', updateGatewayCapabilityConfigurationResponse_capabilityNamespace - The namespace of the gateway capability.

$sel:capabilitySyncStatus:UpdateGatewayCapabilityConfigurationResponse', updateGatewayCapabilityConfigurationResponse_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.

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

Response Lenses

updateGatewayCapabilityConfigurationResponse_httpStatus :: Lens' UpdateGatewayCapabilityConfigurationResponse Int Source #

The response's http status code.

updateGatewayCapabilityConfigurationResponse_capabilityNamespace :: Lens' UpdateGatewayCapabilityConfigurationResponse Text Source #

The namespace of the gateway capability.

updateGatewayCapabilityConfigurationResponse_capabilitySyncStatus :: Lens' UpdateGatewayCapabilityConfigurationResponse 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.

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