Amazonka.GreengrassV2.Types.InstalledComponent

Documentation

data InstalledComponent

Contains information about a component on a Greengrass core device.

See: newInstalledComponent smart constructor.

Constructors

InstalledComponent'

Fields

• componentName :: Maybe Text

  The name of the component.

• componentVersion :: Maybe Text

  The version of the component.

• isRoot :: Maybe Bool

  Whether or not the component is a root component.

• lastInstallationSource :: Maybe Text

  The most recent deployment source that brought the component to the Greengrass core device. For a thing group deployment or thing deployment, the source will be the The ID of the deployment. and for local deployments it will be LOCAL.

• lastReportedTimestamp :: Maybe POSIX

  The last time the Greengrass core device sent a message containing a certain component to the Amazon Web Services Cloud.

  A component does not need to see a state change for this field to update.

• lastStatusChangeTimestamp :: Maybe POSIX

  The status of how current the data is.

  This response is based off of component state changes. The status reflects component disruptions and deployments. If a component only sees a configuration update during a deployment, it might not undergo a state change and this status would not be updated.

• lifecycleState :: Maybe InstalledComponentLifecycleState

  The lifecycle state of the component.

• lifecycleStateDetails :: Maybe Text

  A detailed response about the lifecycle state of the component that explains the reason why a component has an error or is broken.

• lifecycleStatusCodes :: Maybe [Text]

  The status codes that indicate the reason for failure whenever the lifecycleState has an error or is in a broken state.

  Greengrass nucleus v2.8.0 or later is required to get an accurate lifecycleStatusCodes response. This response can be inaccurate in earlier Greengrass nucleus versions.

Instances

FromJSON InstalledComponent

Defined in Amazonka.GreengrassV2.Types.InstalledComponent

Methods

parseJSON :: Value -> Parser InstalledComponent

parseJSONList :: Value -> Parser [InstalledComponent]

Generic InstalledComponent

Defined in Amazonka.GreengrassV2.Types.InstalledComponent

Associated Types

type Rep InstalledComponent :: Type -> Type

Methods

from :: InstalledComponent -> Rep InstalledComponent x

to :: Rep InstalledComponent x -> InstalledComponent

Read InstalledComponent

Defined in Amazonka.GreengrassV2.Types.InstalledComponent

Methods

readsPrec :: Int -> ReadS InstalledComponent

readList :: ReadS [InstalledComponent]

readPrec :: ReadPrec InstalledComponent

readListPrec :: ReadPrec [InstalledComponent]

Show InstalledComponent

Defined in Amazonka.GreengrassV2.Types.InstalledComponent

Methods

showsPrec :: Int -> InstalledComponent -> ShowS

show :: InstalledComponent -> String

showList :: [InstalledComponent] -> ShowS

NFData InstalledComponent

Defined in Amazonka.GreengrassV2.Types.InstalledComponent

Methods

rnf :: InstalledComponent -> ()

Eq InstalledComponent

Defined in Amazonka.GreengrassV2.Types.InstalledComponent

Methods

(==) :: InstalledComponent -> InstalledComponent -> Bool

(/=) :: InstalledComponent -> InstalledComponent -> Bool

Hashable InstalledComponent

Defined in Amazonka.GreengrassV2.Types.InstalledComponent

Methods

hashWithSalt :: Int -> InstalledComponent -> Int

hash :: InstalledComponent -> Int

type Rep InstalledComponent

Defined in Amazonka.GreengrassV2.Types.InstalledComponent

type Rep InstalledComponent = D1 ('MetaData "InstalledComponent" "Amazonka.GreengrassV2.Types.InstalledComponent" "amazonka-greengrassv2-2.0-CXiJQl197i43YI1Cz5IpiZ" 'False) (C1 ('MetaCons "InstalledComponent'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "componentName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "componentVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "isRoot") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "lastInstallationSource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "lastReportedTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "lastStatusChangeTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :*: (S1 ('MetaSel ('Just "lifecycleState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InstalledComponentLifecycleState)) :*: (S1 ('MetaSel ('Just "lifecycleStateDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "lifecycleStatusCodes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))))))

newInstalledComponent :: InstalledComponent

Create a value of InstalledComponent 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:componentName:InstalledComponent', installedComponent_componentName - The name of the component.

$sel:componentVersion:InstalledComponent', installedComponent_componentVersion - The version of the component.

$sel:isRoot:InstalledComponent', installedComponent_isRoot - Whether or not the component is a root component.

$sel:lastInstallationSource:InstalledComponent', installedComponent_lastInstallationSource - The most recent deployment source that brought the component to the Greengrass core device. For a thing group deployment or thing deployment, the source will be the The ID of the deployment. and for local deployments it will be LOCAL.

$sel:lastReportedTimestamp:InstalledComponent', installedComponent_lastReportedTimestamp - The last time the Greengrass core device sent a message containing a certain component to the Amazon Web Services Cloud.

A component does not need to see a state change for this field to update.

$sel:lastStatusChangeTimestamp:InstalledComponent', installedComponent_lastStatusChangeTimestamp - The status of how current the data is.

This response is based off of component state changes. The status reflects component disruptions and deployments. If a component only sees a configuration update during a deployment, it might not undergo a state change and this status would not be updated.

$sel:lifecycleState:InstalledComponent', installedComponent_lifecycleState - The lifecycle state of the component.

$sel:lifecycleStateDetails:InstalledComponent', installedComponent_lifecycleStateDetails - A detailed response about the lifecycle state of the component that explains the reason why a component has an error or is broken.

$sel:lifecycleStatusCodes:InstalledComponent', installedComponent_lifecycleStatusCodes - The status codes that indicate the reason for failure whenever the lifecycleState has an error or is in a broken state.

Greengrass nucleus v2.8.0 or later is required to get an accurate lifecycleStatusCodes response. This response can be inaccurate in earlier Greengrass nucleus versions.

installedComponent_componentName :: Lens' InstalledComponent (Maybe Text)

The name of the component.

installedComponent_componentVersion :: Lens' InstalledComponent (Maybe Text)

The version of the component.

installedComponent_isRoot :: Lens' InstalledComponent (Maybe Bool)

Whether or not the component is a root component.

installedComponent_lastInstallationSource :: Lens' InstalledComponent (Maybe Text)

The most recent deployment source that brought the component to the Greengrass core device. For a thing group deployment or thing deployment, the source will be the The ID of the deployment. and for local deployments it will be LOCAL.

installedComponent_lastReportedTimestamp :: Lens' InstalledComponent (Maybe UTCTime)

The last time the Greengrass core device sent a message containing a certain component to the Amazon Web Services Cloud.

A component does not need to see a state change for this field to update.

installedComponent_lastStatusChangeTimestamp :: Lens' InstalledComponent (Maybe UTCTime)

The status of how current the data is.

This response is based off of component state changes. The status reflects component disruptions and deployments. If a component only sees a configuration update during a deployment, it might not undergo a state change and this status would not be updated.

installedComponent_lifecycleState :: Lens' InstalledComponent (Maybe InstalledComponentLifecycleState)

The lifecycle state of the component.

installedComponent_lifecycleStateDetails :: Lens' InstalledComponent (Maybe Text)

A detailed response about the lifecycle state of the component that explains the reason why a component has an error or is broken.

installedComponent_lifecycleStatusCodes :: Lens' InstalledComponent (Maybe [Text])

The status codes that indicate the reason for failure whenever the lifecycleState has an error or is in a broken state.

Greengrass nucleus v2.8.0 or later is required to get an accurate lifecycleStatusCodes response. This response can be inaccurate in earlier Greengrass nucleus versions.