libZSservicesZSamazonka-greengrassv2ZSamazonka-greengrassv2
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.GreengrassV2.GetCoreDevice

Description

Retrieves metadata for a Greengrass core device.

Synopsis

Creating a Request

data GetCoreDevice Source #

See: newGetCoreDevice smart constructor.

Constructors

GetCoreDevice' 

Fields

Instances

Instances details
Eq GetCoreDevice Source # 
Instance details

Defined in Amazonka.GreengrassV2.GetCoreDevice

Methods

(==) :: GetCoreDevice -> GetCoreDevice -> Bool #

(/=) :: GetCoreDevice -> GetCoreDevice -> Bool #

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 #

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 #

NFData GetCoreDevice Source # 
Instance details

Defined in Amazonka.GreengrassV2.GetCoreDevice

Methods

rnf :: GetCoreDevice -> () #

Hashable GetCoreDevice Source # 
Instance details

Defined in Amazonka.GreengrassV2.GetCoreDevice

Methods

hashWithSalt :: Int -> GetCoreDevice -> Int #

hash :: GetCoreDevice -> Int #

AWSRequest GetCoreDevice Source # 
Instance details

Defined in Amazonka.GreengrassV2.GetCoreDevice

Associated Types

type AWSResponse GetCoreDevice #

Methods

request :: GetCoreDevice -> Request GetCoreDevice #

response :: MonadResource m => Logger -> Service -> Proxy GetCoreDevice -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetCoreDevice))) #

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 #

type Rep GetCoreDevice Source # 
Instance details

Defined in Amazonka.GreengrassV2.GetCoreDevice

type Rep GetCoreDevice = D1 ('MetaData "GetCoreDevice" "Amazonka.GreengrassV2.GetCoreDevice" "libZSservicesZSamazonka-greengrassv2ZSamazonka-greengrassv2" 'False) (C1 ('MetaCons "GetCoreDevice'" 'PrefixI 'True) (S1 ('MetaSel ('Just "coreDeviceThingName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse GetCoreDevice Source # 
Instance details

Defined in Amazonka.GreengrassV2.GetCoreDevice

type AWSResponse GetCoreDevice = GetCoreDeviceResponse

newGetCoreDevice Source #

Arguments

:: Text

$sel:coreDeviceThingName: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:

$sel:coreDeviceThingName: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

  • 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.
  • platform :: Maybe Text

    The operating system platform that the core device runs.

  • 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.

  • 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.

  • 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.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq GetCoreDeviceResponse Source # 
Instance details

Defined in Amazonka.GreengrassV2.GetCoreDevice

Methods

(==) :: GetCoreDeviceResponse -> GetCoreDeviceResponse -> Bool #

(/=) :: GetCoreDeviceResponse -> GetCoreDeviceResponse -> Bool #

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 #

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 #

NFData GetCoreDeviceResponse Source # 
Instance details

Defined in Amazonka.GreengrassV2.GetCoreDevice

Methods

rnf :: GetCoreDeviceResponse -> () #

type Rep GetCoreDeviceResponse Source # 
Instance details

Defined in Amazonka.GreengrassV2.GetCoreDevice

type Rep GetCoreDeviceResponse = D1 ('MetaData "GetCoreDeviceResponse" "Amazonka.GreengrassV2.GetCoreDevice" "libZSservicesZSamazonka-greengrassv2ZSamazonka-greengrassv2" 'False) (C1 ('MetaCons "GetCoreDeviceResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CoreDeviceStatus)) :*: S1 ('MetaSel ('Just "platform") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "architecture") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "coreDeviceThingName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "coreVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "lastStatusUpdateTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: 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:status: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:platform:GetCoreDeviceResponse', getCoreDeviceResponse_platform - The operating system platform that the core device runs.

$sel:architecture:GetCoreDeviceResponse', getCoreDeviceResponse_architecture - The computer architecture of the core device.

$sel:coreDeviceThingName:GetCoreDevice', getCoreDeviceResponse_coreDeviceThingName - The name of the core device. This is also the name of the IoT thing.

$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: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.

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

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

Response Lenses

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_platform :: Lens' GetCoreDeviceResponse (Maybe Text) Source #

The operating system platform that the core device runs.

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_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_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_httpStatus :: Lens' GetCoreDeviceResponse Int Source #

The response's http status code.