Amazonka.IoTSiteWise.DescribeGateway

Retrieves information about a gateway.

Creating a Request

data DescribeGateway

See: newDescribeGateway smart constructor.

Constructors

DescribeGateway'

Fields

• gatewayId :: Text

  The ID of the gateway device.

Instances

ToHeaders DescribeGateway

Defined in Amazonka.IoTSiteWise.DescribeGateway

Methods

toHeaders :: DescribeGateway -> [Header]

ToPath DescribeGateway

Defined in Amazonka.IoTSiteWise.DescribeGateway

Methods

toPath :: DescribeGateway -> ByteString

ToQuery DescribeGateway

Defined in Amazonka.IoTSiteWise.DescribeGateway

Methods

toQuery :: DescribeGateway -> QueryString

AWSRequest DescribeGateway

Defined in Amazonka.IoTSiteWise.DescribeGateway

Associated Types

type AWSResponse DescribeGateway

Methods

request :: (Service -> Service) -> DescribeGateway -> Request DescribeGateway

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeGateway -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeGateway)))

Generic DescribeGateway

Defined in Amazonka.IoTSiteWise.DescribeGateway

Associated Types

type Rep DescribeGateway :: Type -> Type

Methods

from :: DescribeGateway -> Rep DescribeGateway x

to :: Rep DescribeGateway x -> DescribeGateway

Read DescribeGateway

Defined in Amazonka.IoTSiteWise.DescribeGateway

Methods

readsPrec :: Int -> ReadS DescribeGateway

readList :: ReadS [DescribeGateway]

readPrec :: ReadPrec DescribeGateway

readListPrec :: ReadPrec [DescribeGateway]

Show DescribeGateway

Defined in Amazonka.IoTSiteWise.DescribeGateway

Methods

showsPrec :: Int -> DescribeGateway -> ShowS

show :: DescribeGateway -> String

showList :: [DescribeGateway] -> ShowS

NFData DescribeGateway

Defined in Amazonka.IoTSiteWise.DescribeGateway

Methods

rnf :: DescribeGateway -> ()

Eq DescribeGateway

Defined in Amazonka.IoTSiteWise.DescribeGateway

Methods

(==) :: DescribeGateway -> DescribeGateway -> Bool

(/=) :: DescribeGateway -> DescribeGateway -> Bool

Hashable DescribeGateway

Defined in Amazonka.IoTSiteWise.DescribeGateway

Methods

hashWithSalt :: Int -> DescribeGateway -> Int

hash :: DescribeGateway -> Int

type AWSResponse DescribeGateway

Defined in Amazonka.IoTSiteWise.DescribeGateway

type AWSResponse DescribeGateway = DescribeGatewayResponse

type Rep DescribeGateway

Defined in Amazonka.IoTSiteWise.DescribeGateway

type Rep DescribeGateway = D1 ('MetaData "DescribeGateway" "Amazonka.IoTSiteWise.DescribeGateway" "amazonka-iotsitewise-2.0-AK8rDlpQ5oPJsrLUUxJgY" 'False) (C1 ('MetaCons "DescribeGateway'" 'PrefixI 'True) (S1 ('MetaSel ('Just "gatewayId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeGateway

Arguments

:: Text

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:

DescribeGateway, describeGateway_gatewayId - The ID of the gateway device.

Request Lenses

describeGateway_gatewayId :: Lens' DescribeGateway Text

The ID of the gateway device.

Destructuring the Response

data DescribeGatewayResponse

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

Generic DescribeGatewayResponse

Defined in Amazonka.IoTSiteWise.DescribeGateway

Associated Types

type Rep DescribeGatewayResponse :: Type -> Type

Methods

from :: DescribeGatewayResponse -> Rep DescribeGatewayResponse x

to :: Rep DescribeGatewayResponse x -> DescribeGatewayResponse

Read DescribeGatewayResponse

Defined in Amazonka.IoTSiteWise.DescribeGateway

Methods

readsPrec :: Int -> ReadS DescribeGatewayResponse

readList :: ReadS [DescribeGatewayResponse]

readPrec :: ReadPrec DescribeGatewayResponse

readListPrec :: ReadPrec [DescribeGatewayResponse]

Show DescribeGatewayResponse

Defined in Amazonka.IoTSiteWise.DescribeGateway

Methods

showsPrec :: Int -> DescribeGatewayResponse -> ShowS

show :: DescribeGatewayResponse -> String

showList :: [DescribeGatewayResponse] -> ShowS

NFData DescribeGatewayResponse

Defined in Amazonka.IoTSiteWise.DescribeGateway

Methods

rnf :: DescribeGatewayResponse -> ()

Eq DescribeGatewayResponse

Defined in Amazonka.IoTSiteWise.DescribeGateway

Methods

(==) :: DescribeGatewayResponse -> DescribeGatewayResponse -> Bool

(/=) :: DescribeGatewayResponse -> DescribeGatewayResponse -> Bool

type Rep DescribeGatewayResponse

Defined in Amazonka.IoTSiteWise.DescribeGateway

type Rep DescribeGatewayResponse = D1 ('MetaData "DescribeGatewayResponse" "Amazonka.IoTSiteWise.DescribeGateway" "amazonka-iotsitewise-2.0-AK8rDlpQ5oPJsrLUUxJgY" '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

Arguments

:: Int

$sel:httpStatus:DescribeGatewayResponse'

-> Text

DescribeGateway

-> Text

DescribeGatewayResponse

-> Text

$sel:gatewayArn:DescribeGatewayResponse'

-> UTCTime

DescribeGatewayResponse

-> UTCTime

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:

DescribeGatewayResponse, describeGatewayResponse_gatewayPlatform - The gateway's platform.

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

DescribeGateway, describeGatewayResponse_gatewayId - The ID of the gateway device.

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}

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.

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

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

Response Lenses

describeGatewayResponse_gatewayPlatform :: Lens' DescribeGatewayResponse (Maybe GatewayPlatform)

The gateway's platform.

describeGatewayResponse_httpStatus :: Lens' DescribeGatewayResponse Int

The response's http status code.

describeGatewayResponse_gatewayId :: Lens' DescribeGatewayResponse Text

The ID of the gateway device.

describeGatewayResponse_gatewayName :: Lens' DescribeGatewayResponse Text

The name of the gateway.

describeGatewayResponse_gatewayArn :: Lens' DescribeGatewayResponse Text

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

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

describeGatewayResponse_gatewayCapabilitySummaries :: Lens' DescribeGatewayResponse [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.

describeGatewayResponse_creationDate :: Lens' DescribeGatewayResponse UTCTime

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

describeGatewayResponse_lastUpdateDate :: Lens' DescribeGatewayResponse UTCTime

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