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.GreengrassV2.GetCoreDevice

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves metadata for a Greengrass core device.

IoT Greengrass relies on individual devices to send status updates to the Amazon Web Services Cloud. If the IoT Greengrass Core software isn't running on the device, or if device isn't connected to the Amazon Web Services Cloud, then the reported status of that device might not reflect its current status. The status timestamp indicates when the device status was last updated.

Core devices send status updates at the following times:

When the IoT Greengrass Core software starts
When the core device receives a deployment from the Amazon Web Services Cloud
When the status of any component on the core device becomes BROKEN
At a regular interval that you can configure, which defaults to 24 hours
For IoT Greengrass Core v2.7.0, the core device sends status updates upon local deployment and cloud deployment

Synopsis

data GetCoreDevice = GetCoreDevice' {
- coreDeviceThingName :: Text
}
newGetCoreDevice :: Text -> GetCoreDevice
getCoreDevice_coreDeviceThingName :: Lens' GetCoreDevice Text
data GetCoreDeviceResponse = GetCoreDeviceResponse' {
- architecture :: Maybe Text
- coreDeviceThingName :: Maybe Text
- coreVersion :: Maybe Text
- lastStatusUpdateTimestamp :: Maybe POSIX
- platform :: Maybe Text
- status :: Maybe CoreDeviceStatus
- tags :: Maybe (HashMap Text Text)
- httpStatus :: Int
}
newGetCoreDeviceResponse :: Int -> GetCoreDeviceResponse
getCoreDeviceResponse_architecture :: Lens' GetCoreDeviceResponse (Maybe Text)
getCoreDeviceResponse_coreDeviceThingName :: Lens' GetCoreDeviceResponse (Maybe Text)
getCoreDeviceResponse_coreVersion :: Lens' GetCoreDeviceResponse (Maybe Text)
getCoreDeviceResponse_lastStatusUpdateTimestamp :: Lens' GetCoreDeviceResponse (Maybe UTCTime)
getCoreDeviceResponse_platform :: Lens' GetCoreDeviceResponse (Maybe Text)
getCoreDeviceResponse_status :: Lens' GetCoreDeviceResponse (Maybe CoreDeviceStatus)
getCoreDeviceResponse_tags :: Lens' GetCoreDeviceResponse (Maybe (HashMap Text Text))
getCoreDeviceResponse_httpStatus :: Lens' GetCoreDeviceResponse Int

Creating a Request

data GetCoreDevice Source #

See: newGetCoreDevice smart constructor.

Constructors

GetCoreDevice'
Fields coreDeviceThingName :: Text The name of the core device. This is also the name of the IoT thing.

Instances

Instances details

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

newGetCoreDevice Source #

Arguments

:: Text	`GetCoreDevice`
-> GetCoreDevice

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

GetCoreDevice, getCoreDevice_coreDeviceThingName - The name of the core device. This is also the name of the IoT thing.

Request Lenses

getCoreDevice_coreDeviceThingName :: Lens' GetCoreDevice Text Source #

The name of the core device. This is also the name of the IoT thing.

Destructuring the Response

data GetCoreDeviceResponse Source #

See: newGetCoreDeviceResponse smart constructor.

Constructors

GetCoreDeviceResponse'

Fields

architecture :: Maybe Text
The computer architecture of the core device.
coreDeviceThingName :: Maybe Text
The name of the core device. This is also the name of the IoT thing.
coreVersion :: Maybe Text
The version of the IoT Greengrass Core software that the core device runs. This version is equivalent to the version of the Greengrass nucleus component that runs on the core device. For more information, see the Greengrass nucleus component in the IoT Greengrass V2 Developer Guide.
lastStatusUpdateTimestamp :: Maybe POSIX
The time at which the core device's status last updated, expressed in ISO 8601 format.
platform :: Maybe Text
The operating system platform that the core device runs.
status :: Maybe CoreDeviceStatus
The status of the core device. The core device status can be:
- HEALTHY – The IoT Greengrass Core software and all components run on the core device without issue.
- UNHEALTHY – The IoT Greengrass Core software or a component is in a failed state on the core device.
tags :: Maybe (HashMap Text Text)
A list of key-value pairs that contain metadata for the resource. For more information, see Tag your resources in the IoT Greengrass V2 Developer Guide.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic GetCoreDeviceResponse Source #
Instance details Defined in Amazonka.GreengrassV2.GetCoreDevice Associated Types type Rep GetCoreDeviceResponse :: Type -> Type # Methods from :: GetCoreDeviceResponse -> Rep GetCoreDeviceResponse x # to :: Rep GetCoreDeviceResponse x -> GetCoreDeviceResponse #
Read GetCoreDeviceResponse Source #
Instance details Defined in Amazonka.GreengrassV2.GetCoreDevice Methods readsPrec :: Int -> ReadS GetCoreDeviceResponse # readList :: ReadS [GetCoreDeviceResponse] # readPrec :: ReadPrec GetCoreDeviceResponse # readListPrec :: ReadPrec [GetCoreDeviceResponse] #
Show GetCoreDeviceResponse Source #
Instance details Defined in Amazonka.GreengrassV2.GetCoreDevice Methods showsPrec :: Int -> GetCoreDeviceResponse -> ShowS # show :: GetCoreDeviceResponse -> String # showList :: [GetCoreDeviceResponse] -> ShowS #
NFData GetCoreDeviceResponse Source #
Instance details Defined in Amazonka.GreengrassV2.GetCoreDevice Methods rnf :: GetCoreDeviceResponse -> () #
Eq GetCoreDeviceResponse Source #
Instance details Defined in Amazonka.GreengrassV2.GetCoreDevice Methods (==) :: GetCoreDeviceResponse -> GetCoreDeviceResponse -> Bool # (/=) :: GetCoreDeviceResponse -> GetCoreDeviceResponse -> Bool #
type Rep GetCoreDeviceResponse Source #
Instance details Defined in Amazonka.GreengrassV2.GetCoreDevice type Rep GetCoreDeviceResponse = D1 ('MetaData "GetCoreDeviceResponse" "Amazonka.GreengrassV2.GetCoreDevice" "amazonka-greengrassv2-2.0-CXiJQl197i43YI1Cz5IpiZ" 'False) (C1 ('MetaCons "GetCoreDeviceResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "architecture") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "coreDeviceThingName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "coreVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "lastStatusUpdateTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :: ((S1 ('MetaSel ('Just "platform") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CoreDeviceStatus))) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newGetCoreDeviceResponse Source #

Arguments

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

Create a value of GetCoreDeviceResponse 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:architecture:GetCoreDeviceResponse', getCoreDeviceResponse_architecture - The computer architecture of the core device.

GetCoreDevice, getCoreDeviceResponse_coreDeviceThingName - The name of the core device. This is also the name of the IoT thing.

$sel:coreVersion:GetCoreDeviceResponse', getCoreDeviceResponse_coreVersion - The version of the IoT Greengrass Core software that the core device runs. This version is equivalent to the version of the Greengrass nucleus component that runs on the core device. For more information, see the Greengrass nucleus component in the IoT Greengrass V2 Developer Guide.

GetCoreDeviceResponse, getCoreDeviceResponse_lastStatusUpdateTimestamp - The time at which the core device's status last updated, expressed in ISO 8601 format.

$sel:platform:GetCoreDeviceResponse', getCoreDeviceResponse_platform - The operating system platform that the core device runs.

GetCoreDeviceResponse, getCoreDeviceResponse_status - The status of the core device. The core device status can be:

HEALTHY – The IoT Greengrass Core software and all components run on the core device without issue.
UNHEALTHY – The IoT Greengrass Core software or a component is in a failed state on the core device.

$sel:tags:GetCoreDeviceResponse', getCoreDeviceResponse_tags - A list of key-value pairs that contain metadata for the resource. For more information, see Tag your resources in the IoT Greengrass V2 Developer Guide.

$sel:httpStatus:GetCoreDeviceResponse', getCoreDeviceResponse_httpStatus - The response's http status code.

Response Lenses

getCoreDeviceResponse_architecture :: Lens' GetCoreDeviceResponse (Maybe Text) Source #

The computer architecture of the core device.

getCoreDeviceResponse_coreDeviceThingName :: Lens' GetCoreDeviceResponse (Maybe Text) Source #

The name of the core device. This is also the name of the IoT thing.

getCoreDeviceResponse_coreVersion :: Lens' GetCoreDeviceResponse (Maybe Text) Source #

The version of the IoT Greengrass Core software that the core device runs. This version is equivalent to the version of the Greengrass nucleus component that runs on the core device. For more information, see the Greengrass nucleus component in the IoT Greengrass V2 Developer Guide.

getCoreDeviceResponse_lastStatusUpdateTimestamp :: Lens' GetCoreDeviceResponse (Maybe UTCTime) Source #

The time at which the core device's status last updated, expressed in ISO 8601 format.

getCoreDeviceResponse_platform :: Lens' GetCoreDeviceResponse (Maybe Text) Source #

The operating system platform that the core device runs.

getCoreDeviceResponse_status :: Lens' GetCoreDeviceResponse (Maybe CoreDeviceStatus) Source #

The status of the core device. The core device status can be:

HEALTHY – The IoT Greengrass Core software and all components run on the core device without issue.
UNHEALTHY – The IoT Greengrass Core software or a component is in a failed state on the core device.

getCoreDeviceResponse_tags :: Lens' GetCoreDeviceResponse (Maybe (HashMap Text Text)) Source #

A list of key-value pairs that contain metadata for the resource. For more information, see Tag your resources in the IoT Greengrass V2 Developer Guide.

getCoreDeviceResponse_httpStatus :: Lens' GetCoreDeviceResponse Int Source #

The response's http status code.