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.Types.CloudComponentStatus

Description

Documentation

data CloudComponentStatus Source #

Contains the status of a component version in the IoT Greengrass service.

See: newCloudComponentStatus smart constructor.

Constructors

CloudComponentStatus'

Fields

componentState :: Maybe CloudComponentState
The state of the component version.
errors :: Maybe (HashMap Text Text)
A dictionary of errors that communicate why the component version is in an error state. For example, if IoT Greengrass can't access an artifact for the component version, then errors contains the artifact's URI as a key, and the error message as the value for that key.
message :: Maybe Text
A message that communicates details, such as errors, about the status of the component version.
vendorGuidance :: Maybe VendorGuidance
The vendor guidance state for the component version. This state indicates whether the component version has any issues that you should consider before you deploy it. The vendor guidance state can be:
- ACTIVE – This component version is available and recommended for use.
- DISCONTINUED – This component version has been discontinued by its publisher. You can deploy this component version, but we recommend that you use a different version of this component.
- DELETED – This component version has been deleted by its publisher, so you can't deploy it. If you have any existing deployments that specify this component version, those deployments will fail.
vendorGuidanceMessage :: Maybe Text
A message that communicates details about the vendor guidance state of the component version. This message communicates why a component version is discontinued or deleted.

Instances

Instances details

FromJSON CloudComponentStatus Source #
Instance details Defined in Amazonka.GreengrassV2.Types.CloudComponentStatus Methods parseJSON :: Value -> Parser CloudComponentStatus # parseJSONList :: Value -> Parser [CloudComponentStatus] #
Generic CloudComponentStatus Source #
Instance details Defined in Amazonka.GreengrassV2.Types.CloudComponentStatus Associated Types type Rep CloudComponentStatus :: Type -> Type # Methods from :: CloudComponentStatus -> Rep CloudComponentStatus x # to :: Rep CloudComponentStatus x -> CloudComponentStatus #
Read CloudComponentStatus Source #
Instance details Defined in Amazonka.GreengrassV2.Types.CloudComponentStatus Methods readsPrec :: Int -> ReadS CloudComponentStatus # readList :: ReadS [CloudComponentStatus] # readPrec :: ReadPrec CloudComponentStatus # readListPrec :: ReadPrec [CloudComponentStatus] #
Show CloudComponentStatus Source #
Instance details Defined in Amazonka.GreengrassV2.Types.CloudComponentStatus Methods showsPrec :: Int -> CloudComponentStatus -> ShowS # show :: CloudComponentStatus -> String # showList :: [CloudComponentStatus] -> ShowS #
NFData CloudComponentStatus Source #
Instance details Defined in Amazonka.GreengrassV2.Types.CloudComponentStatus Methods rnf :: CloudComponentStatus -> () #
Eq CloudComponentStatus Source #
Instance details Defined in Amazonka.GreengrassV2.Types.CloudComponentStatus Methods (==) :: CloudComponentStatus -> CloudComponentStatus -> Bool # (/=) :: CloudComponentStatus -> CloudComponentStatus -> Bool #
Hashable CloudComponentStatus Source #
Instance details Defined in Amazonka.GreengrassV2.Types.CloudComponentStatus Methods hashWithSalt :: Int -> CloudComponentStatus -> Int # hash :: CloudComponentStatus -> Int #
type Rep CloudComponentStatus Source #
Instance details Defined in Amazonka.GreengrassV2.Types.CloudComponentStatus type Rep CloudComponentStatus = D1 ('MetaData "CloudComponentStatus" "Amazonka.GreengrassV2.Types.CloudComponentStatus" "amazonka-greengrassv2-2.0-CXiJQl197i43YI1Cz5IpiZ" 'False) (C1 ('MetaCons "CloudComponentStatus'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "componentState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CloudComponentState)) :: S1 ('MetaSel ('Just "errors") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :: (S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "vendorGuidance") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VendorGuidance)) :: S1 ('MetaSel ('Just "vendorGuidanceMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newCloudComponentStatus :: CloudComponentStatus Source #

Create a value of CloudComponentStatus 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:componentState:CloudComponentStatus', cloudComponentStatus_componentState - The state of the component version.

$sel:errors:CloudComponentStatus', cloudComponentStatus_errors - A dictionary of errors that communicate why the component version is in an error state. For example, if IoT Greengrass can't access an artifact for the component version, then errors contains the artifact's URI as a key, and the error message as the value for that key.

$sel:message:CloudComponentStatus', cloudComponentStatus_message - A message that communicates details, such as errors, about the status of the component version.

$sel:vendorGuidance:CloudComponentStatus', cloudComponentStatus_vendorGuidance - The vendor guidance state for the component version. This state indicates whether the component version has any issues that you should consider before you deploy it. The vendor guidance state can be:

ACTIVE – This component version is available and recommended for use.
DISCONTINUED – This component version has been discontinued by its publisher. You can deploy this component version, but we recommend that you use a different version of this component.
DELETED – This component version has been deleted by its publisher, so you can't deploy it. If you have any existing deployments that specify this component version, those deployments will fail.

$sel:vendorGuidanceMessage:CloudComponentStatus', cloudComponentStatus_vendorGuidanceMessage - A message that communicates details about the vendor guidance state of the component version. This message communicates why a component version is discontinued or deleted.

cloudComponentStatus_componentState :: Lens' CloudComponentStatus (Maybe CloudComponentState) Source #

The state of the component version.

cloudComponentStatus_errors :: Lens' CloudComponentStatus (Maybe (HashMap Text Text)) Source #

A dictionary of errors that communicate why the component version is in an error state. For example, if IoT Greengrass can't access an artifact for the component version, then errors contains the artifact's URI as a key, and the error message as the value for that key.

cloudComponentStatus_message :: Lens' CloudComponentStatus (Maybe Text) Source #

A message that communicates details, such as errors, about the status of the component version.

cloudComponentStatus_vendorGuidance :: Lens' CloudComponentStatus (Maybe VendorGuidance) Source #

The vendor guidance state for the component version. This state indicates whether the component version has any issues that you should consider before you deploy it. The vendor guidance state can be:

ACTIVE – This component version is available and recommended for use.
DISCONTINUED – This component version has been discontinued by its publisher. You can deploy this component version, but we recommend that you use a different version of this component.
DELETED – This component version has been deleted by its publisher, so you can't deploy it. If you have any existing deployments that specify this component version, those deployments will fail.

cloudComponentStatus_vendorGuidanceMessage :: Lens' CloudComponentStatus (Maybe Text) Source #

A message that communicates details about the vendor guidance state of the component version. This message communicates why a component version is discontinued or deleted.