libZSservicesZSamazonka-iotsitewiseZSamazonka-iotsitewise
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.IoTSiteWise.Types.VariableValue

Description

 
Synopsis

Documentation

data VariableValue Source #

Identifies a property value used in an expression.

See: newVariableValue smart constructor.

Constructors

VariableValue' 

Fields

  • hierarchyId :: Maybe Text

    The ID of the hierarchy to query for the property ID. You can use the hierarchy's name instead of the hierarchy's ID.

    You use a hierarchy ID instead of a model ID because you can have several hierarchies using the same model and therefore the same propertyId. For example, you might have separately grouped assets that come from the same asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide.

  • propertyId :: Text

    The ID of the property to use as the variable. You can use the property name if it's from the same asset model.

Instances

Instances details
Eq VariableValue Source # 
Instance details

Defined in Amazonka.IoTSiteWise.Types.VariableValue

Read VariableValue Source # 
Instance details

Defined in Amazonka.IoTSiteWise.Types.VariableValue

Show VariableValue Source # 
Instance details

Defined in Amazonka.IoTSiteWise.Types.VariableValue

Generic VariableValue Source # 
Instance details

Defined in Amazonka.IoTSiteWise.Types.VariableValue

Associated Types

type Rep VariableValue :: Type -> Type #

NFData VariableValue Source # 
Instance details

Defined in Amazonka.IoTSiteWise.Types.VariableValue

Methods

rnf :: VariableValue -> () #

Hashable VariableValue Source # 
Instance details

Defined in Amazonka.IoTSiteWise.Types.VariableValue

ToJSON VariableValue Source # 
Instance details

Defined in Amazonka.IoTSiteWise.Types.VariableValue

FromJSON VariableValue Source # 
Instance details

Defined in Amazonka.IoTSiteWise.Types.VariableValue

type Rep VariableValue Source # 
Instance details

Defined in Amazonka.IoTSiteWise.Types.VariableValue

type Rep VariableValue = D1 ('MetaData "VariableValue" "Amazonka.IoTSiteWise.Types.VariableValue" "libZSservicesZSamazonka-iotsitewiseZSamazonka-iotsitewise" 'False) (C1 ('MetaCons "VariableValue'" 'PrefixI 'True) (S1 ('MetaSel ('Just "hierarchyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "propertyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newVariableValue Source #

Create a value of VariableValue 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:hierarchyId:VariableValue', variableValue_hierarchyId - The ID of the hierarchy to query for the property ID. You can use the hierarchy's name instead of the hierarchy's ID.

You use a hierarchy ID instead of a model ID because you can have several hierarchies using the same model and therefore the same propertyId. For example, you might have separately grouped assets that come from the same asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide.

$sel:propertyId:VariableValue', variableValue_propertyId - The ID of the property to use as the variable. You can use the property name if it's from the same asset model.

variableValue_hierarchyId :: Lens' VariableValue (Maybe Text) Source #

The ID of the hierarchy to query for the property ID. You can use the hierarchy's name instead of the hierarchy's ID.

You use a hierarchy ID instead of a model ID because you can have several hierarchies using the same model and therefore the same propertyId. For example, you might have separately grouped assets that come from the same asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide.

variableValue_propertyId :: Lens' VariableValue Text Source #

The ID of the property to use as the variable. You can use the property name if it's from the same asset model.