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.SnowDeviceManagement.DescribeDevice

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Checks device-specific information, such as the device type, software version, IP addresses, and lock status.

Synopsis

data DescribeDevice = DescribeDevice' {
- managedDeviceId :: Text
}
newDescribeDevice :: Text -> DescribeDevice
describeDevice_managedDeviceId :: Lens' DescribeDevice Text
data DescribeDeviceResponse = DescribeDeviceResponse' {
- associatedWithJob :: Maybe Text
- deviceCapacities :: Maybe [Capacity]
- deviceState :: Maybe UnlockState
- deviceType :: Maybe Text
- lastReachedOutAt :: Maybe POSIX
- lastUpdatedAt :: Maybe POSIX
- managedDeviceArn :: Maybe Text
- managedDeviceId :: Maybe Text
- physicalNetworkInterfaces :: Maybe [PhysicalNetworkInterface]
- software :: Maybe SoftwareInformation
- tags :: Maybe (HashMap Text Text)
- httpStatus :: Int
}
newDescribeDeviceResponse :: Int -> DescribeDeviceResponse
describeDeviceResponse_associatedWithJob :: Lens' DescribeDeviceResponse (Maybe Text)
describeDeviceResponse_deviceCapacities :: Lens' DescribeDeviceResponse (Maybe [Capacity])
describeDeviceResponse_deviceState :: Lens' DescribeDeviceResponse (Maybe UnlockState)
describeDeviceResponse_deviceType :: Lens' DescribeDeviceResponse (Maybe Text)
describeDeviceResponse_lastReachedOutAt :: Lens' DescribeDeviceResponse (Maybe UTCTime)
describeDeviceResponse_lastUpdatedAt :: Lens' DescribeDeviceResponse (Maybe UTCTime)
describeDeviceResponse_managedDeviceArn :: Lens' DescribeDeviceResponse (Maybe Text)
describeDeviceResponse_managedDeviceId :: Lens' DescribeDeviceResponse (Maybe Text)
describeDeviceResponse_physicalNetworkInterfaces :: Lens' DescribeDeviceResponse (Maybe [PhysicalNetworkInterface])
describeDeviceResponse_software :: Lens' DescribeDeviceResponse (Maybe SoftwareInformation)
describeDeviceResponse_tags :: Lens' DescribeDeviceResponse (Maybe (HashMap Text Text))
describeDeviceResponse_httpStatus :: Lens' DescribeDeviceResponse Int

Creating a Request

data DescribeDevice Source #

See: newDescribeDevice smart constructor.

Constructors

DescribeDevice'
Fields managedDeviceId :: Text The ID of the device that you are checking the information of.

Instances

Instances details

ToJSON DescribeDevice Source #
Instance details Defined in Amazonka.SnowDeviceManagement.DescribeDevice Methods toJSON :: DescribeDevice -> Value # toEncoding :: DescribeDevice -> Encoding # toJSONList :: [DescribeDevice] -> Value # toEncodingList :: [DescribeDevice] -> Encoding #
ToHeaders DescribeDevice Source #
Instance details Defined in Amazonka.SnowDeviceManagement.DescribeDevice Methods toHeaders :: DescribeDevice -> [Header] #
ToPath DescribeDevice Source #
Instance details Defined in Amazonka.SnowDeviceManagement.DescribeDevice Methods toPath :: DescribeDevice -> ByteString #
ToQuery DescribeDevice Source #
Instance details Defined in Amazonka.SnowDeviceManagement.DescribeDevice Methods toQuery :: DescribeDevice -> QueryString #
AWSRequest DescribeDevice Source #
Instance details Defined in Amazonka.SnowDeviceManagement.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.SnowDeviceManagement.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.SnowDeviceManagement.DescribeDevice Methods readsPrec :: Int -> ReadS DescribeDevice # readList :: ReadS [DescribeDevice] # readPrec :: ReadPrec DescribeDevice # readListPrec :: ReadPrec [DescribeDevice] #
Show DescribeDevice Source #
Instance details Defined in Amazonka.SnowDeviceManagement.DescribeDevice Methods showsPrec :: Int -> DescribeDevice -> ShowS # show :: DescribeDevice -> String # showList :: [DescribeDevice] -> ShowS #
NFData DescribeDevice Source #
Instance details Defined in Amazonka.SnowDeviceManagement.DescribeDevice Methods rnf :: DescribeDevice -> () #
Eq DescribeDevice Source #
Instance details Defined in Amazonka.SnowDeviceManagement.DescribeDevice Methods (==) :: DescribeDevice -> DescribeDevice -> Bool # (/=) :: DescribeDevice -> DescribeDevice -> Bool #
Hashable DescribeDevice Source #
Instance details Defined in Amazonka.SnowDeviceManagement.DescribeDevice Methods hashWithSalt :: Int -> DescribeDevice -> Int # hash :: DescribeDevice -> Int #
type AWSResponse DescribeDevice Source #
Instance details Defined in Amazonka.SnowDeviceManagement.DescribeDevice type AWSResponse DescribeDevice = DescribeDeviceResponse
type Rep DescribeDevice Source #
Instance details Defined in Amazonka.SnowDeviceManagement.DescribeDevice type Rep DescribeDevice = D1 ('MetaData "DescribeDevice" "Amazonka.SnowDeviceManagement.DescribeDevice" "amazonka-snow-device-management-2.0-BSOYMJEGkqv86alAaVucXA" 'False) (C1 ('MetaCons "DescribeDevice'" 'PrefixI 'True) (S1 ('MetaSel ('Just "managedDeviceId") '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_managedDeviceId - The ID of the device that you are checking the information of.

Request Lenses

describeDevice_managedDeviceId :: Lens' DescribeDevice Text Source #

The ID of the device that you are checking the information of.

Destructuring the Response

data DescribeDeviceResponse Source #

See: newDescribeDeviceResponse smart constructor.

Constructors

DescribeDeviceResponse'

Fields

associatedWithJob :: Maybe Text
The ID of the job used when ordering the device.
deviceCapacities :: Maybe [Capacity]
The hardware specifications of the device.
deviceState :: Maybe UnlockState
The current state of the device.
deviceType :: Maybe Text
The type of Amazon Web Services Snow Family device.
lastReachedOutAt :: Maybe POSIX
When the device last contacted the Amazon Web Services Cloud. Indicates that the device is online.
lastUpdatedAt :: Maybe POSIX
When the device last pushed an update to the Amazon Web Services Cloud. Indicates when the device cache was refreshed.
managedDeviceArn :: Maybe Text
The Amazon Resource Name (ARN) of the device.
managedDeviceId :: Maybe Text
The ID of the device that you checked the information for.
physicalNetworkInterfaces :: Maybe [PhysicalNetworkInterface]
The network interfaces available on the device.
software :: Maybe SoftwareInformation
The software installed on the device.
tags :: Maybe (HashMap Text Text)
Optional metadata that you assign to a resource. You can use tags to categorize a resource in different ways, such as by purpose, owner, or environment.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic DescribeDeviceResponse Source #
Instance details Defined in Amazonka.SnowDeviceManagement.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.SnowDeviceManagement.DescribeDevice Methods readsPrec :: Int -> ReadS DescribeDeviceResponse # readList :: ReadS [DescribeDeviceResponse] # readPrec :: ReadPrec DescribeDeviceResponse # readListPrec :: ReadPrec [DescribeDeviceResponse] #
Show DescribeDeviceResponse Source #
Instance details Defined in Amazonka.SnowDeviceManagement.DescribeDevice Methods showsPrec :: Int -> DescribeDeviceResponse -> ShowS # show :: DescribeDeviceResponse -> String # showList :: [DescribeDeviceResponse] -> ShowS #
NFData DescribeDeviceResponse Source #
Instance details Defined in Amazonka.SnowDeviceManagement.DescribeDevice Methods rnf :: DescribeDeviceResponse -> () #
Eq DescribeDeviceResponse Source #
Instance details Defined in Amazonka.SnowDeviceManagement.DescribeDevice Methods (==) :: DescribeDeviceResponse -> DescribeDeviceResponse -> Bool # (/=) :: DescribeDeviceResponse -> DescribeDeviceResponse -> Bool #
type Rep DescribeDeviceResponse Source #
Instance details Defined in Amazonka.SnowDeviceManagement.DescribeDevice type Rep DescribeDeviceResponse = D1 ('MetaData "DescribeDeviceResponse" "Amazonka.SnowDeviceManagement.DescribeDevice" "amazonka-snow-device-management-2.0-BSOYMJEGkqv86alAaVucXA" 'False) (C1 ('MetaCons "DescribeDeviceResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "associatedWithJob") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "deviceCapacities") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Capacity])) :: S1 ('MetaSel ('Just "deviceState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UnlockState)))) :: (S1 ('MetaSel ('Just "deviceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "lastReachedOutAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "lastUpdatedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))))) :: ((S1 ('MetaSel ('Just "managedDeviceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "managedDeviceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "physicalNetworkInterfaces") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PhysicalNetworkInterface])))) :: (S1 ('MetaSel ('Just "software") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SoftwareInformation)) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: 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:

DescribeDeviceResponse, describeDeviceResponse_associatedWithJob - The ID of the job used when ordering the device.

$sel:deviceCapacities:DescribeDeviceResponse', describeDeviceResponse_deviceCapacities - The hardware specifications of the device.

$sel:deviceState:DescribeDeviceResponse', describeDeviceResponse_deviceState - The current state of the device.

$sel:deviceType:DescribeDeviceResponse', describeDeviceResponse_deviceType - The type of Amazon Web Services Snow Family device.

$sel:lastReachedOutAt:DescribeDeviceResponse', describeDeviceResponse_lastReachedOutAt - When the device last contacted the Amazon Web Services Cloud. Indicates that the device is online.

DescribeDeviceResponse, describeDeviceResponse_lastUpdatedAt - When the device last pushed an update to the Amazon Web Services Cloud. Indicates when the device cache was refreshed.

DescribeDeviceResponse, describeDeviceResponse_managedDeviceArn - The Amazon Resource Name (ARN) of the device.

DescribeDevice, describeDeviceResponse_managedDeviceId - The ID of the device that you checked the information for.

$sel:physicalNetworkInterfaces:DescribeDeviceResponse', describeDeviceResponse_physicalNetworkInterfaces - The network interfaces available on the device.

$sel:software:DescribeDeviceResponse', describeDeviceResponse_software - The software installed on the device.

DescribeDeviceResponse, describeDeviceResponse_tags - Optional metadata that you assign to a resource. You can use tags to categorize a resource in different ways, such as by purpose, owner, or environment.

$sel:httpStatus:DescribeDeviceResponse', describeDeviceResponse_httpStatus - The response's http status code.

Response Lenses

describeDeviceResponse_associatedWithJob :: Lens' DescribeDeviceResponse (Maybe Text) Source #

The ID of the job used when ordering the device.

describeDeviceResponse_deviceCapacities :: Lens' DescribeDeviceResponse (Maybe [Capacity]) Source #

The hardware specifications of the device.

describeDeviceResponse_deviceState :: Lens' DescribeDeviceResponse (Maybe UnlockState) Source #

The current state of the device.

describeDeviceResponse_deviceType :: Lens' DescribeDeviceResponse (Maybe Text) Source #

The type of Amazon Web Services Snow Family device.

describeDeviceResponse_lastReachedOutAt :: Lens' DescribeDeviceResponse (Maybe UTCTime) Source #

When the device last contacted the Amazon Web Services Cloud. Indicates that the device is online.

describeDeviceResponse_lastUpdatedAt :: Lens' DescribeDeviceResponse (Maybe UTCTime) Source #

When the device last pushed an update to the Amazon Web Services Cloud. Indicates when the device cache was refreshed.

describeDeviceResponse_managedDeviceArn :: Lens' DescribeDeviceResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the device.

describeDeviceResponse_managedDeviceId :: Lens' DescribeDeviceResponse (Maybe Text) Source #

The ID of the device that you checked the information for.

describeDeviceResponse_physicalNetworkInterfaces :: Lens' DescribeDeviceResponse (Maybe [PhysicalNetworkInterface]) Source #

The network interfaces available on the device.

describeDeviceResponse_software :: Lens' DescribeDeviceResponse (Maybe SoftwareInformation) Source #

The software installed on the device.

describeDeviceResponse_tags :: Lens' DescribeDeviceResponse (Maybe (HashMap Text Text)) Source #

Optional metadata that you assign to a resource. You can use tags to categorize a resource in different ways, such as by purpose, owner, or environment.

describeDeviceResponse_httpStatus :: Lens' DescribeDeviceResponse Int Source #

The response's http status code.