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 |
Returns information about a device.
Synopsis
- data DescribeDevice = DescribeDevice' {}
- 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.
Instances
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.
DescribeDeviceResponse' | |
|
Instances
newDescribeDeviceResponse Source #
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.
$sel:httpStatus:DescribeDeviceResponse'
, describeDeviceResponse_httpStatus
- The response's http status code.
Response Lenses
describeDeviceResponse_alternateSoftwares :: Lens' DescribeDeviceResponse (Maybe [AlternateSoftwareMetadata]) Source #
Beta software releases available for the device.
describeDeviceResponse_arn :: Lens' DescribeDeviceResponse (Maybe Text) Source #
The device's ARN.
describeDeviceResponse_brand :: Lens' DescribeDeviceResponse (Maybe DeviceBrand) Source #
The device's maker.
describeDeviceResponse_createdTime :: Lens' DescribeDeviceResponse (Maybe UTCTime) Source #
When the device was created.
describeDeviceResponse_currentNetworkingStatus :: Lens' DescribeDeviceResponse (Maybe NetworkStatus) Source #
The device's networking status.
describeDeviceResponse_currentSoftware :: Lens' DescribeDeviceResponse (Maybe Text) Source #
The device's current software version.
describeDeviceResponse_description :: Lens' DescribeDeviceResponse (Maybe Text) Source #
The device's description.
describeDeviceResponse_deviceAggregatedStatus :: Lens' DescribeDeviceResponse (Maybe DeviceAggregatedStatus) Source #
A device's aggregated status. Including the device's connection status, provisioning status, and lease status.
describeDeviceResponse_deviceConnectionStatus :: Lens' DescribeDeviceResponse (Maybe DeviceConnectionStatus) Source #
The device's connection status.
describeDeviceResponse_deviceId :: Lens' DescribeDeviceResponse (Maybe Text) Source #
The device's ID.
describeDeviceResponse_latestAlternateSoftware :: Lens' DescribeDeviceResponse (Maybe Text) Source #
The most recent beta software release.
describeDeviceResponse_latestDeviceJob :: Lens' DescribeDeviceResponse (Maybe LatestDeviceJob) Source #
A device's latest job. Includes the target image version, and the job status.
describeDeviceResponse_latestSoftware :: Lens' DescribeDeviceResponse (Maybe Text) Source #
The latest software version available for the device.
describeDeviceResponse_leaseExpirationTime :: Lens' DescribeDeviceResponse (Maybe UTCTime) Source #
The device's lease expiration time.
describeDeviceResponse_name :: Lens' DescribeDeviceResponse (Maybe Text) Source #
The device's name.
describeDeviceResponse_networkingConfiguration :: Lens' DescribeDeviceResponse (Maybe NetworkPayload) Source #
The device's networking configuration.
describeDeviceResponse_provisioningStatus :: Lens' DescribeDeviceResponse (Maybe DeviceStatus) Source #
The device's provisioning status.
describeDeviceResponse_serialNumber :: Lens' DescribeDeviceResponse (Maybe Text) Source #
The device's serial number.
describeDeviceResponse_tags :: Lens' DescribeDeviceResponse (Maybe (HashMap Text Text)) Source #
The device's tags.
describeDeviceResponse_type :: Lens' DescribeDeviceResponse (Maybe DeviceType) Source #
The device's type.
describeDeviceResponse_httpStatus :: Lens' DescribeDeviceResponse Int Source #
The response's http status code.