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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves information about a gateway 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 DescribeGatewayCapabilityConfiguration Source #

See: newDescribeGatewayCapabilityConfiguration smart constructor.

Constructors

DescribeGatewayCapabilityConfiguration'
Fields gatewayId :: Text The ID of the gateway that defines the capability configuration. 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`.

Instances

Instances details

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

newDescribeGatewayCapabilityConfiguration Source #

Arguments

:: Text	`$sel:gatewayId:DescribeGatewayCapabilityConfiguration'`
-> Text	`$sel:capabilityNamespace:DescribeGatewayCapabilityConfiguration'`
-> DescribeGatewayCapabilityConfiguration

Create a value of DescribeGatewayCapabilityConfiguration 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:DescribeGatewayCapabilityConfiguration', describeGatewayCapabilityConfiguration_gatewayId - The ID of the gateway that defines the capability configuration.

$sel:capabilityNamespace:DescribeGatewayCapabilityConfiguration', describeGatewayCapabilityConfiguration_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.

Request Lenses

describeGatewayCapabilityConfiguration_gatewayId :: Lens' DescribeGatewayCapabilityConfiguration Text Source #

The ID of the gateway that defines the capability configuration.

describeGatewayCapabilityConfiguration_capabilityNamespace :: Lens' DescribeGatewayCapabilityConfiguration 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.

Destructuring the Response

data DescribeGatewayCapabilityConfigurationResponse Source #

See: newDescribeGatewayCapabilityConfigurationResponse smart constructor.

Constructors

DescribeGatewayCapabilityConfigurationResponse'

Fields

httpStatus :: Int
The response's http status code.
gatewayId :: Text
The ID of the gateway that defines the capability configuration.
capabilityNamespace :: Text
The namespace of the gateway capability.
capabilityConfiguration :: Text
The JSON document that defines the gateway capability's configuration. For more information, see Configuring data sources (CLI) in the IoT SiteWise User Guide.
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 DescribeGatewayCapabilityConfigurationResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribeGatewayCapabilityConfiguration Methods (==) :: DescribeGatewayCapabilityConfigurationResponse -> DescribeGatewayCapabilityConfigurationResponse -> Bool # (/=) :: DescribeGatewayCapabilityConfigurationResponse -> DescribeGatewayCapabilityConfigurationResponse -> Bool #
Read DescribeGatewayCapabilityConfigurationResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribeGatewayCapabilityConfiguration Methods readsPrec :: Int -> ReadS DescribeGatewayCapabilityConfigurationResponse # readList :: ReadS [DescribeGatewayCapabilityConfigurationResponse] # readPrec :: ReadPrec DescribeGatewayCapabilityConfigurationResponse # readListPrec :: ReadPrec [DescribeGatewayCapabilityConfigurationResponse] #
Show DescribeGatewayCapabilityConfigurationResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribeGatewayCapabilityConfiguration Methods showsPrec :: Int -> DescribeGatewayCapabilityConfigurationResponse -> ShowS # show :: DescribeGatewayCapabilityConfigurationResponse -> String # showList :: [DescribeGatewayCapabilityConfigurationResponse] -> ShowS #
Generic DescribeGatewayCapabilityConfigurationResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribeGatewayCapabilityConfiguration Associated Types type Rep DescribeGatewayCapabilityConfigurationResponse :: Type -> Type # Methods from :: DescribeGatewayCapabilityConfigurationResponse -> Rep DescribeGatewayCapabilityConfigurationResponse x # to :: Rep DescribeGatewayCapabilityConfigurationResponse x -> DescribeGatewayCapabilityConfigurationResponse #
NFData DescribeGatewayCapabilityConfigurationResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribeGatewayCapabilityConfiguration Methods rnf :: DescribeGatewayCapabilityConfigurationResponse -> () #
type Rep DescribeGatewayCapabilityConfigurationResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribeGatewayCapabilityConfiguration type Rep DescribeGatewayCapabilityConfigurationResponse = D1 ('MetaData "DescribeGatewayCapabilityConfigurationResponse" "Amazonka.IoTSiteWise.DescribeGatewayCapabilityConfiguration" "libZSservicesZSamazonka-iotsitewiseZSamazonka-iotsitewise" 'False) (C1 ('MetaCons "DescribeGatewayCapabilityConfigurationResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: 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) :: S1 ('MetaSel ('Just "capabilitySyncStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 CapabilitySyncStatus)))))

newDescribeGatewayCapabilityConfigurationResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeGatewayCapabilityConfigurationResponse'`
-> Text	`$sel:gatewayId:DescribeGatewayCapabilityConfiguration'`
-> Text	`$sel:capabilityNamespace:DescribeGatewayCapabilityConfiguration'`
-> Text	`$sel:capabilityConfiguration:DescribeGatewayCapabilityConfigurationResponse'`
-> CapabilitySyncStatus	`$sel:capabilitySyncStatus:DescribeGatewayCapabilityConfigurationResponse'`
-> DescribeGatewayCapabilityConfigurationResponse

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

$sel:gatewayId:DescribeGatewayCapabilityConfiguration', describeGatewayCapabilityConfigurationResponse_gatewayId - The ID of the gateway that defines the capability configuration.

$sel:capabilityNamespace:DescribeGatewayCapabilityConfiguration', describeGatewayCapabilityConfigurationResponse_capabilityNamespace - The namespace of the gateway capability.

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

$sel:capabilitySyncStatus:DescribeGatewayCapabilityConfigurationResponse', describeGatewayCapabilityConfigurationResponse_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.

Response Lenses

describeGatewayCapabilityConfigurationResponse_httpStatus :: Lens' DescribeGatewayCapabilityConfigurationResponse Int Source #

The response's http status code.

describeGatewayCapabilityConfigurationResponse_gatewayId :: Lens' DescribeGatewayCapabilityConfigurationResponse Text Source #

The ID of the gateway that defines the capability configuration.

describeGatewayCapabilityConfigurationResponse_capabilityNamespace :: Lens' DescribeGatewayCapabilityConfigurationResponse Text Source #

The namespace of the gateway capability.

describeGatewayCapabilityConfigurationResponse_capabilityConfiguration :: Lens' DescribeGatewayCapabilityConfigurationResponse Text Source #

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

describeGatewayCapabilityConfigurationResponse_capabilitySyncStatus :: Lens' DescribeGatewayCapabilityConfigurationResponse 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.