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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves information about a gateway.

Synopsis

data DescribeGateway = DescribeGateway' {
- gatewayId :: Text
}
newDescribeGateway :: Text -> DescribeGateway
describeGateway_gatewayId :: Lens' DescribeGateway Text
data DescribeGatewayResponse = DescribeGatewayResponse' {
- gatewayPlatform :: Maybe GatewayPlatform
- httpStatus :: Int
- gatewayId :: Text
- gatewayName :: Text
- gatewayArn :: Text
- gatewayCapabilitySummaries :: [GatewayCapabilitySummary]
- creationDate :: POSIX
- lastUpdateDate :: POSIX
}
newDescribeGatewayResponse :: Int -> Text -> Text -> Text -> UTCTime -> UTCTime -> DescribeGatewayResponse
describeGatewayResponse_gatewayPlatform :: Lens' DescribeGatewayResponse (Maybe GatewayPlatform)
describeGatewayResponse_httpStatus :: Lens' DescribeGatewayResponse Int
describeGatewayResponse_gatewayId :: Lens' DescribeGatewayResponse Text
describeGatewayResponse_gatewayName :: Lens' DescribeGatewayResponse Text
describeGatewayResponse_gatewayArn :: Lens' DescribeGatewayResponse Text
describeGatewayResponse_gatewayCapabilitySummaries :: Lens' DescribeGatewayResponse [GatewayCapabilitySummary]
describeGatewayResponse_creationDate :: Lens' DescribeGatewayResponse UTCTime
describeGatewayResponse_lastUpdateDate :: Lens' DescribeGatewayResponse UTCTime

Creating a Request

data DescribeGateway Source #

See: newDescribeGateway smart constructor.

Constructors

DescribeGateway'
Fields gatewayId :: Text The ID of the gateway device.

Instances

Instances details

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

newDescribeGateway Source #

Arguments

:: Text	`$sel:gatewayId:DescribeGateway'`
-> DescribeGateway

Create a value of DescribeGateway 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:DescribeGateway', describeGateway_gatewayId - The ID of the gateway device.

Request Lenses

describeGateway_gatewayId :: Lens' DescribeGateway Text Source #

The ID of the gateway device.

Destructuring the Response

data DescribeGatewayResponse Source #

See: newDescribeGatewayResponse smart constructor.

Constructors

DescribeGatewayResponse'

Fields

gatewayPlatform :: Maybe GatewayPlatform
The gateway's platform.
httpStatus :: Int
The response's http status code.
gatewayId :: Text
The ID of the gateway device.
gatewayName :: Text
The name of the gateway.

gatewayArn :: Text

The ARN of the gateway, which has the following format.

arn:${Partition}:iotsitewise:${Region}:${Account}:gateway/${GatewayId}

gatewayCapabilitySummaries :: [GatewayCapabilitySummary]
A list of gateway capability summaries that each contain a namespace and status. Each gateway capability defines data sources for the gateway. To retrieve a capability configuration's definition, use DescribeGatewayCapabilityConfiguration.
creationDate :: POSIX
The date the gateway was created, in Unix epoch time.
lastUpdateDate :: POSIX
The date the gateway was last updated, in Unix epoch time.

Instances

Instances details

Eq DescribeGatewayResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribeGateway Methods (==) :: DescribeGatewayResponse -> DescribeGatewayResponse -> Bool # (/=) :: DescribeGatewayResponse -> DescribeGatewayResponse -> Bool #
Read DescribeGatewayResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribeGateway Methods readsPrec :: Int -> ReadS DescribeGatewayResponse # readList :: ReadS [DescribeGatewayResponse] # readPrec :: ReadPrec DescribeGatewayResponse # readListPrec :: ReadPrec [DescribeGatewayResponse] #
Show DescribeGatewayResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribeGateway Methods showsPrec :: Int -> DescribeGatewayResponse -> ShowS # show :: DescribeGatewayResponse -> String # showList :: [DescribeGatewayResponse] -> ShowS #
Generic DescribeGatewayResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribeGateway Associated Types type Rep DescribeGatewayResponse :: Type -> Type # Methods from :: DescribeGatewayResponse -> Rep DescribeGatewayResponse x # to :: Rep DescribeGatewayResponse x -> DescribeGatewayResponse #
NFData DescribeGatewayResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribeGateway Methods rnf :: DescribeGatewayResponse -> () #
type Rep DescribeGatewayResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribeGateway type Rep DescribeGatewayResponse = D1 ('MetaData "DescribeGatewayResponse" "Amazonka.IoTSiteWise.DescribeGateway" "libZSservicesZSamazonka-iotsitewiseZSamazonka-iotsitewise" 'False) (C1 ('MetaCons "DescribeGatewayResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "gatewayPlatform") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe GatewayPlatform)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)) :: (S1 ('MetaSel ('Just "gatewayId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "gatewayName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :: ((S1 ('MetaSel ('Just "gatewayArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "gatewayCapabilitySummaries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [GatewayCapabilitySummary])) :: (S1 ('MetaSel ('Just "creationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :*: S1 ('MetaSel ('Just "lastUpdateDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX)))))

newDescribeGatewayResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeGatewayResponse'`
-> Text	`$sel:gatewayId:DescribeGateway'`
-> Text	`$sel:gatewayName:DescribeGatewayResponse'`
-> Text	`$sel:gatewayArn:DescribeGatewayResponse'`
-> UTCTime	`$sel:creationDate:DescribeGatewayResponse'`
-> UTCTime	`$sel:lastUpdateDate:DescribeGatewayResponse'`
-> DescribeGatewayResponse

Create a value of DescribeGatewayResponse 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:gatewayPlatform:DescribeGatewayResponse', describeGatewayResponse_gatewayPlatform - The gateway's platform.

$sel:httpStatus:DescribeGatewayResponse', describeGatewayResponse_httpStatus - The response's http status code.

$sel:gatewayId:DescribeGateway', describeGatewayResponse_gatewayId - The ID of the gateway device.

$sel:gatewayName:DescribeGatewayResponse', describeGatewayResponse_gatewayName - The name of the gateway.

$sel:gatewayArn:DescribeGatewayResponse', describeGatewayResponse_gatewayArn - The ARN of the gateway, which has the following format.

arn:${Partition}:iotsitewise:${Region}:${Account}:gateway/${GatewayId}

$sel:gatewayCapabilitySummaries:DescribeGatewayResponse', describeGatewayResponse_gatewayCapabilitySummaries - A list of gateway capability summaries that each contain a namespace and status. Each gateway capability defines data sources for the gateway. To retrieve a capability configuration's definition, use DescribeGatewayCapabilityConfiguration.

$sel:creationDate:DescribeGatewayResponse', describeGatewayResponse_creationDate - The date the gateway was created, in Unix epoch time.

$sel:lastUpdateDate:DescribeGatewayResponse', describeGatewayResponse_lastUpdateDate - The date the gateway was last updated, in Unix epoch time.

Response Lenses

describeGatewayResponse_gatewayPlatform :: Lens' DescribeGatewayResponse (Maybe GatewayPlatform) Source #

The gateway's platform.

describeGatewayResponse_httpStatus :: Lens' DescribeGatewayResponse Int Source #

The response's http status code.

describeGatewayResponse_gatewayId :: Lens' DescribeGatewayResponse Text Source #

The ID of the gateway device.

describeGatewayResponse_gatewayName :: Lens' DescribeGatewayResponse Text Source #

The name of the gateway.

describeGatewayResponse_gatewayArn :: Lens' DescribeGatewayResponse Text Source #

The ARN of the gateway, which has the following format.

arn:${Partition}:iotsitewise:${Region}:${Account}:gateway/${GatewayId}

describeGatewayResponse_gatewayCapabilitySummaries :: Lens' DescribeGatewayResponse [GatewayCapabilitySummary] Source #

A list of gateway capability summaries that each contain a namespace and status. Each gateway capability defines data sources for the gateway. To retrieve a capability configuration's definition, use DescribeGatewayCapabilityConfiguration.

describeGatewayResponse_creationDate :: Lens' DescribeGatewayResponse UTCTime Source #

The date the gateway was created, in Unix epoch time.

describeGatewayResponse_lastUpdateDate :: Lens' DescribeGatewayResponse UTCTime Source #

The date the gateway was last updated, in Unix epoch time.