Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Panorama.DescribeDevice

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns information about a device.

Synopsis

data DescribeDevice = DescribeDevice' {
- deviceId :: Text
}
newDescribeDevice :: Text -> DescribeDevice
describeDevice_deviceId :: Lens' DescribeDevice Text
data DescribeDeviceResponse = DescribeDeviceResponse' {
- alternateSoftwares :: Maybe [AlternateSoftwareMetadata]
- arn :: Maybe Text
- brand :: Maybe DeviceBrand
- createdTime :: Maybe POSIX
- currentNetworkingStatus :: Maybe NetworkStatus
- currentSoftware :: Maybe Text
- description :: Maybe Text
- deviceAggregatedStatus :: Maybe DeviceAggregatedStatus
- deviceConnectionStatus :: Maybe DeviceConnectionStatus
- deviceId :: Maybe Text
- latestAlternateSoftware :: Maybe Text
- latestDeviceJob :: Maybe LatestDeviceJob
- latestSoftware :: Maybe Text
- leaseExpirationTime :: Maybe POSIX
- name :: Maybe Text
- networkingConfiguration :: Maybe NetworkPayload
- provisioningStatus :: Maybe DeviceStatus
- serialNumber :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- type' :: Maybe DeviceType
- httpStatus :: Int
}
newDescribeDeviceResponse :: Int -> DescribeDeviceResponse
describeDeviceResponse_alternateSoftwares :: Lens' DescribeDeviceResponse (Maybe [AlternateSoftwareMetadata])
describeDeviceResponse_arn :: Lens' DescribeDeviceResponse (Maybe Text)
describeDeviceResponse_brand :: Lens' DescribeDeviceResponse (Maybe DeviceBrand)
describeDeviceResponse_createdTime :: Lens' DescribeDeviceResponse (Maybe UTCTime)
describeDeviceResponse_currentNetworkingStatus :: Lens' DescribeDeviceResponse (Maybe NetworkStatus)
describeDeviceResponse_currentSoftware :: Lens' DescribeDeviceResponse (Maybe Text)
describeDeviceResponse_description :: Lens' DescribeDeviceResponse (Maybe Text)
describeDeviceResponse_deviceAggregatedStatus :: Lens' DescribeDeviceResponse (Maybe DeviceAggregatedStatus)
describeDeviceResponse_deviceConnectionStatus :: Lens' DescribeDeviceResponse (Maybe DeviceConnectionStatus)
describeDeviceResponse_deviceId :: Lens' DescribeDeviceResponse (Maybe Text)
describeDeviceResponse_latestAlternateSoftware :: Lens' DescribeDeviceResponse (Maybe Text)
describeDeviceResponse_latestDeviceJob :: Lens' DescribeDeviceResponse (Maybe LatestDeviceJob)
describeDeviceResponse_latestSoftware :: Lens' DescribeDeviceResponse (Maybe Text)
describeDeviceResponse_leaseExpirationTime :: Lens' DescribeDeviceResponse (Maybe UTCTime)
describeDeviceResponse_name :: Lens' DescribeDeviceResponse (Maybe Text)
describeDeviceResponse_networkingConfiguration :: Lens' DescribeDeviceResponse (Maybe NetworkPayload)
describeDeviceResponse_provisioningStatus :: Lens' DescribeDeviceResponse (Maybe DeviceStatus)
describeDeviceResponse_serialNumber :: Lens' DescribeDeviceResponse (Maybe Text)
describeDeviceResponse_tags :: Lens' DescribeDeviceResponse (Maybe (HashMap Text Text))
describeDeviceResponse_type :: Lens' DescribeDeviceResponse (Maybe DeviceType)
describeDeviceResponse_httpStatus :: Lens' DescribeDeviceResponse Int

Creating a Request

data DescribeDevice Source #

See: newDescribeDevice smart constructor.

Constructors

DescribeDevice'
Fields deviceId :: Text The device's ID.

Instances

Instances details

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

newDescribeDevice Source #

Arguments

:: Text	`DescribeDevice`
-> DescribeDevice

Create a value of DescribeDevice 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:

DescribeDevice, describeDevice_deviceId - The device's ID.

Request Lenses

describeDevice_deviceId :: Lens' DescribeDevice Text Source #

The device's ID.

Destructuring the Response

data DescribeDeviceResponse Source #

See: newDescribeDeviceResponse smart constructor.

Constructors

DescribeDeviceResponse'

Fields

alternateSoftwares :: Maybe [AlternateSoftwareMetadata]
Beta software releases available for the device.
arn :: Maybe Text
The device's ARN.
brand :: Maybe DeviceBrand
The device's maker.
createdTime :: Maybe POSIX
When the device was created.
currentNetworkingStatus :: Maybe NetworkStatus
The device's networking status.
currentSoftware :: Maybe Text
The device's current software version.
description :: Maybe Text
The device's description.
deviceAggregatedStatus :: Maybe DeviceAggregatedStatus
A device's aggregated status. Including the device's connection status, provisioning status, and lease status.
deviceConnectionStatus :: Maybe DeviceConnectionStatus
The device's connection status.
deviceId :: Maybe Text
The device's ID.
latestAlternateSoftware :: Maybe Text
The most recent beta software release.
latestDeviceJob :: Maybe LatestDeviceJob
A device's latest job. Includes the target image version, and the job status.
latestSoftware :: Maybe Text
The latest software version available for the device.
leaseExpirationTime :: Maybe POSIX
The device's lease expiration time.
name :: Maybe Text
The device's name.
networkingConfiguration :: Maybe NetworkPayload
The device's networking configuration.
provisioningStatus :: Maybe DeviceStatus
The device's provisioning status.
serialNumber :: Maybe Text
The device's serial number.
tags :: Maybe (HashMap Text Text)
The device's tags.
type' :: Maybe DeviceType
The device's type.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic DescribeDeviceResponse Source #
Instance details Defined in Amazonka.Panorama.DescribeDevice Associated Types type Rep DescribeDeviceResponse :: Type -> Type # Methods from :: DescribeDeviceResponse -> Rep DescribeDeviceResponse x # to :: Rep DescribeDeviceResponse x -> DescribeDeviceResponse #
Read DescribeDeviceResponse Source #
Instance details Defined in Amazonka.Panorama.DescribeDevice Methods readsPrec :: Int -> ReadS DescribeDeviceResponse # readList :: ReadS [DescribeDeviceResponse] # readPrec :: ReadPrec DescribeDeviceResponse # readListPrec :: ReadPrec [DescribeDeviceResponse] #
Show DescribeDeviceResponse Source #
Instance details Defined in Amazonka.Panorama.DescribeDevice Methods showsPrec :: Int -> DescribeDeviceResponse -> ShowS # show :: DescribeDeviceResponse -> String # showList :: [DescribeDeviceResponse] -> ShowS #
NFData DescribeDeviceResponse Source #
Instance details Defined in Amazonka.Panorama.DescribeDevice Methods rnf :: DescribeDeviceResponse -> () #
Eq DescribeDeviceResponse Source #
Instance details Defined in Amazonka.Panorama.DescribeDevice Methods (==) :: DescribeDeviceResponse -> DescribeDeviceResponse -> Bool # (/=) :: DescribeDeviceResponse -> DescribeDeviceResponse -> Bool #
type Rep DescribeDeviceResponse Source #
Instance details Defined in Amazonka.Panorama.DescribeDevice type Rep DescribeDeviceResponse = D1 ('MetaData "DescribeDeviceResponse" "Amazonka.Panorama.DescribeDevice" "amazonka-panorama-2.0-9Y2Sxd8ToqsBjPczgPI6n1" 'False) (C1 ('MetaCons "DescribeDeviceResponse'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "alternateSoftwares") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AlternateSoftwareMetadata])) :: S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "brand") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DeviceBrand)) :: (S1 ('MetaSel ('Just "createdTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "currentNetworkingStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NetworkStatus))))) :: ((S1 ('MetaSel ('Just "currentSoftware") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "deviceAggregatedStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DeviceAggregatedStatus)) :: (S1 ('MetaSel ('Just "deviceConnectionStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DeviceConnectionStatus)) :: S1 ('MetaSel ('Just "deviceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))) :: (((S1 ('MetaSel ('Just "latestAlternateSoftware") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "latestDeviceJob") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LatestDeviceJob))) :: (S1 ('MetaSel ('Just "latestSoftware") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "leaseExpirationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "networkingConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NetworkPayload)) :: (S1 ('MetaSel ('Just "provisioningStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DeviceStatus)) :: S1 ('MetaSel ('Just "serialNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: (S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DeviceType)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))))

newDescribeDeviceResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeDeviceResponse'`
-> DescribeDeviceResponse

Create a value of DescribeDeviceResponse 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:alternateSoftwares:DescribeDeviceResponse', describeDeviceResponse_alternateSoftwares - Beta software releases available for the device.

DescribeDeviceResponse, describeDeviceResponse_arn - The device's ARN.

DescribeDeviceResponse, describeDeviceResponse_brand - The device's maker.

DescribeDeviceResponse, describeDeviceResponse_createdTime - When the device was created.

$sel:currentNetworkingStatus:DescribeDeviceResponse', describeDeviceResponse_currentNetworkingStatus - The device's networking status.

DescribeDeviceResponse, describeDeviceResponse_currentSoftware - The device's current software version.

DescribeDeviceResponse, describeDeviceResponse_description - The device's description.

DescribeDeviceResponse, describeDeviceResponse_deviceAggregatedStatus - A device's aggregated status. Including the device's connection status, provisioning status, and lease status.

$sel:deviceConnectionStatus:DescribeDeviceResponse', describeDeviceResponse_deviceConnectionStatus - The device's connection status.

DescribeDevice, describeDeviceResponse_deviceId - The device's ID.

$sel:latestAlternateSoftware:DescribeDeviceResponse', describeDeviceResponse_latestAlternateSoftware - The most recent beta software release.

DescribeDeviceResponse, describeDeviceResponse_latestDeviceJob - A device's latest job. Includes the target image version, and the job status.

$sel:latestSoftware:DescribeDeviceResponse', describeDeviceResponse_latestSoftware - The latest software version available for the device.

DescribeDeviceResponse, describeDeviceResponse_leaseExpirationTime - The device's lease expiration time.

DescribeDeviceResponse, describeDeviceResponse_name - The device's name.

$sel:networkingConfiguration:DescribeDeviceResponse', describeDeviceResponse_networkingConfiguration - The device's networking configuration.

DescribeDeviceResponse, describeDeviceResponse_provisioningStatus - The device's provisioning status.

$sel:serialNumber:DescribeDeviceResponse', describeDeviceResponse_serialNumber - The device's serial number.

DescribeDeviceResponse, describeDeviceResponse_tags - The device's tags.

DescribeDeviceResponse, describeDeviceResponse_type - The device's type.