Amazonka.IoTEvents.Types.AssetPropertyVariant

Documentation

data AssetPropertyVariant

A structure that contains an asset property value. For more information, see Variant in the AWS IoT SiteWise API Reference.

You must use expressions for all parameters in AssetPropertyVariant. The expressions accept literals, operators, functions, references, and substitution templates.

Examples

• For literal values, the expressions must contain single quotes. For example, the value for the integerValue parameter can be '100'.
• For references, you must specify either variables or parameters. For example, the value for the booleanValue parameter can be $variable.offline.

• For a substitution template, you must use ${}, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.

  In the following example, the value for the doubleValue parameter uses a substitution template.

  '${$input.TemperatureInput.sensorData.temperature * 6 / 5 + 32}'

For more information, see Expressions in the AWS IoT Events Developer Guide.

You must specify one of the following value types, depending on the dataType of the specified asset property. For more information, see AssetProperty in the AWS IoT SiteWise API Reference.

See: newAssetPropertyVariant smart constructor.

Constructors

AssetPropertyVariant'

Fields

• booleanValue :: Maybe Text

  The asset property value is a Boolean value that must be 'TRUE' or 'FALSE'. You must use an expression, and the evaluated result should be a Boolean value.

• doubleValue :: Maybe Text

  The asset property value is a double. You must use an expression, and the evaluated result should be a double.

• integerValue :: Maybe Text

  The asset property value is an integer. You must use an expression, and the evaluated result should be an integer.

• stringValue :: Maybe Text

  The asset property value is a string. You must use an expression, and the evaluated result should be a string.

Instances

FromJSON AssetPropertyVariant

Defined in Amazonka.IoTEvents.Types.AssetPropertyVariant

Methods

parseJSON :: Value -> Parser AssetPropertyVariant

parseJSONList :: Value -> Parser [AssetPropertyVariant]

ToJSON AssetPropertyVariant

Defined in Amazonka.IoTEvents.Types.AssetPropertyVariant

Methods

toJSON :: AssetPropertyVariant -> Value

toEncoding :: AssetPropertyVariant -> Encoding

toJSONList :: [AssetPropertyVariant] -> Value

toEncodingList :: [AssetPropertyVariant] -> Encoding

Generic AssetPropertyVariant

Defined in Amazonka.IoTEvents.Types.AssetPropertyVariant

Associated Types

type Rep AssetPropertyVariant :: Type -> Type

Methods

from :: AssetPropertyVariant -> Rep AssetPropertyVariant x

to :: Rep AssetPropertyVariant x -> AssetPropertyVariant

Read AssetPropertyVariant

Defined in Amazonka.IoTEvents.Types.AssetPropertyVariant

Methods

readsPrec :: Int -> ReadS AssetPropertyVariant

readList :: ReadS [AssetPropertyVariant]

readPrec :: ReadPrec AssetPropertyVariant

readListPrec :: ReadPrec [AssetPropertyVariant]

Show AssetPropertyVariant

Defined in Amazonka.IoTEvents.Types.AssetPropertyVariant

Methods

showsPrec :: Int -> AssetPropertyVariant -> ShowS

show :: AssetPropertyVariant -> String

showList :: [AssetPropertyVariant] -> ShowS

NFData AssetPropertyVariant

Defined in Amazonka.IoTEvents.Types.AssetPropertyVariant

Methods

rnf :: AssetPropertyVariant -> ()

Eq AssetPropertyVariant

Defined in Amazonka.IoTEvents.Types.AssetPropertyVariant

Methods

(==) :: AssetPropertyVariant -> AssetPropertyVariant -> Bool

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

Hashable AssetPropertyVariant

Defined in Amazonka.IoTEvents.Types.AssetPropertyVariant

Methods

hashWithSalt :: Int -> AssetPropertyVariant -> Int

hash :: AssetPropertyVariant -> Int

type Rep AssetPropertyVariant

Defined in Amazonka.IoTEvents.Types.AssetPropertyVariant

type Rep AssetPropertyVariant = D1 ('MetaData "AssetPropertyVariant" "Amazonka.IoTEvents.Types.AssetPropertyVariant" "amazonka-iotevents-2.0-6xKaLx5KciSK3LEs0FyRYn" 'False) (C1 ('MetaCons "AssetPropertyVariant'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "booleanValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "doubleValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "integerValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "stringValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newAssetPropertyVariant :: AssetPropertyVariant

Create a value of AssetPropertyVariant 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:booleanValue:AssetPropertyVariant', assetPropertyVariant_booleanValue - The asset property value is a Boolean value that must be 'TRUE' or 'FALSE'. You must use an expression, and the evaluated result should be a Boolean value.

$sel:doubleValue:AssetPropertyVariant', assetPropertyVariant_doubleValue - The asset property value is a double. You must use an expression, and the evaluated result should be a double.

$sel:integerValue:AssetPropertyVariant', assetPropertyVariant_integerValue - The asset property value is an integer. You must use an expression, and the evaluated result should be an integer.

$sel:stringValue:AssetPropertyVariant', assetPropertyVariant_stringValue - The asset property value is a string. You must use an expression, and the evaluated result should be a string.

assetPropertyVariant_booleanValue :: Lens' AssetPropertyVariant (Maybe Text)

The asset property value is a Boolean value that must be 'TRUE' or 'FALSE'. You must use an expression, and the evaluated result should be a Boolean value.

assetPropertyVariant_doubleValue :: Lens' AssetPropertyVariant (Maybe Text)

The asset property value is a double. You must use an expression, and the evaluated result should be a double.

assetPropertyVariant_integerValue :: Lens' AssetPropertyVariant (Maybe Text)

The asset property value is an integer. You must use an expression, and the evaluated result should be an integer.

assetPropertyVariant_stringValue :: Lens' AssetPropertyVariant (Maybe Text)

The asset property value is a string. You must use an expression, and the evaluated result should be a string.